Get your package listed

This catalog reads the npm registry. Publish to npm with the right keyword, and your package appears here.

1. Add an omp keyword

Add one of omp-package, omp-plugin, omp-extension, oh-my-pi to keywords in package.json. Packages with one of these keywords show as Built for omp.

{
  "name": "my-omp-plugin",
  "keywords": ["omp-plugin"]
}

2. Declare what omp loads

omp reads the omp field in package.json. List your extension entry points there.

"omp": {
  "extensions": ["./extensions/my-plugin.ts"]
}

3. Publish to npm

npm publish --access public

4. Wait for the sync

The catalog reads npm every 30 minutes, a few pages at a time. A full pass takes about 6 hours. Then users can install your package with omp plugin install <name>.

5. Add a badge

Each package page has a badge that shows the current omp status. Copy its Markdown into your README.

pi packages

Packages with only the pi-package keyword are listed as Untested on omp until users report a result. Packages that are only on GitHub are not listed.