> ## Documentation Index
> Fetch the complete documentation index at: https://staging-docs.orderly.network/llms.txt
> Use this file to discover all available pages before exploring further.

# How to write `usagePrompt` and the GitHub README

> Guide for how to write `usageprompt` and the github readme

## `usagePrompt` (Builders Marketplace / manifest)

`usagePrompt` is shown to **AI assistants and integrators** who install your plugin. It should describe **how to add the plugin to a host app**, not marketing feature copy.

### Constraints (CLI / API aligned)

* Max length **8192** characters (validated on submit/update in the devkit).
* Focus on **integration**: install command, import path, `OrderlyAppProvider` `plugins` snippet, env vars, build steps, pitfalls.

### Suggested outline

1. **Install** — npm/pnpm command or package name.
2. **Register** — code snippet showing `plugins={[registerXxx()]}`.
3. **Config** — env vars, broker IDs, feature flags.
4. **Build** — `pnpm build` or codegen if required.
5. **Pitfalls** — known conflicts, version pins, ordering with other plugins.

### Example (markdown fragment)

```markdown theme={null}
Install: pnpm add @scope/my-plugin
Register:
\`\`\`tsx
import registerMyPlugin from "@scope/my-plugin";
<OrderlyAppProvider plugins={[registerMyPlugin()]} ... />
\`\`\`
Config: Set FEATURE_X=true for analytics mode.
Pitfalls: Requires @orderly.network/plugin-core ^x.y.z matching the host.
```

Place `usagePrompt` in `.orderly-manifest.json` (or supply via tooling that writes the manifest). See [Manifest and submit](/build-on-omnichain/builder-marketplace/manifest-and-submit).

## GitHub README

The README is **not** uploaded to the Builders Marketplace API, but it is the human-facing home for your repo. Suggested structure:

1. **Title + one-liner**
2. **Overview** — audience and behavior
3. **Install**
4. **Usage** — minimal code sample
5. **Configuration**
6. **Interceptors** — table of targets | description (strings must match [Runtime injector targets](/build-on-omnichain/builder-marketplace/runtime-injector-targets))
7. **Development** — scripts, Storybook link if any
8. **License**

Keep README and `usagePrompt` consistent on package name, import path, and registration shape.