wehub-resource-sync
26 lines
761 B
Markdown
26 lines
761 B
Markdown
---
|
|
name: career-ops-plugin-{{NAME}}
|
|
description: How to use the {{NAME}} plugin and the data it produces.
|
|
license: MIT
|
|
---
|
|
|
|
# {{NAME}}
|
|
|
|
> This file teaches an AI agent how to drive THIS plugin. Keep it scoped to the
|
|
> plugin's own domain — it must not instruct the agent to edit core files, change
|
|
> scoring, or act outside the plugin's declared hooks.
|
|
|
|
## How to run it
|
|
|
|
- `node plugins.mjs run {{NAME}}` — runs the plugin's hook.
|
|
|
|
## What it produces
|
|
|
|
TODO: describe the data structure. For a producer hook, the `Job[]` fields you
|
|
emit (title, url, company, location). For an export hook, what you push and where.
|
|
|
|
## Settings
|
|
|
|
TODO: any non-secret options the user sets in `config/plugins.yml` under
|
|
`plugins.{{NAME}}` (these arrive as `ctx.settings`).
|