|
4 | 4 | [mods hub](https://commandcode.ai/mods). The hub reads it live, so a merged PR here lists |
5 | 5 | your mod within minutes — no website deploy. |
6 | 6 |
|
7 | | -Two ways a mod gets listed: |
8 | | - |
9 | | -1. **Publish to npm with the `cmd-mod` keyword** — it is discovered automatically, no PR needed. |
10 | | -2. **Open a PR against `registry.json`** — for git-only mods, or to add richer metadata. This is that path. |
| 7 | +Every listed mod has a reviewed entry in `registry.json`. Publish your mod to npm |
| 8 | +or GitHub, then open a PR against this file. Publishing an npm package with the |
| 9 | +`cmd-mod` keyword helps maintainers discover it for review; it does not list it |
| 10 | +automatically. Existing GitHub entries continue to load from the file without |
| 11 | +an npm review or a website deployment. |
11 | 12 |
|
12 | 13 | ## Add your mod |
13 | 14 |
|
@@ -37,10 +38,17 @@ against [`registry.schema.json`](./registry.schema.json). |
37 | 38 | | `author` | yes | `{ "name": "…" }` required; optional `github` / `url` link the name | |
38 | 39 | | `kinds` | yes | one or more of `tool` `command` `hook` `provider` `renderer` `flag` | |
39 | 40 | | `repo` | no | a GitHub URL also enables the star count | |
40 | | -| `npm` | no | links the entry to its npm package for live download counts | |
| 41 | +| `npm` | no | names its published npm package for live metadata and download counts | |
41 | 42 | | `tags` | no | lowercase slugs, searchable | |
42 | 43 | | `addedAt` | no | `YYYY-MM-DD`, used for the "Newest" sort | |
43 | 44 |
|
44 | 45 | `official`, `featured`, and the top-level `hidden` list are maintainer-only — leave them out of your PR. |
45 | 46 |
|
46 | 47 | Keep the array valid JSON (no trailing commas) and one mod per PR where you can, so review stays quick. |
| 48 | + |
| 49 | +For an npm mod, set both `source` and `npm` to the full package name, including |
| 50 | +its scope. Give scoped packages a separate unique lowercase `name` matching the |
| 51 | +schema. The entry supplies the description, author, categories, and tags; npm |
| 52 | +adds the latest version, publish date, and monthly downloads. A GitHub `repo` |
| 53 | +adds its star count. Maintainers review the published package code before |
| 54 | +listing it. Review is not a sandbox or a guarantee about future releases. |
0 commit comments