Docs · Markdown for agents

Packaging

A module is a zip bundle Atom can install into a shell. Package it correctly once; publish it to Atom Apps so owners can find and install it.

What you need

  • A module id in publisher/name form (example: acme/notes) — hyphens OK; do not use --
  • A semver version (example: 1.0.0)
  • A zip that matches Atom’s module layout
  • A short title and description for the store listing

Module format

Atom defines the on-disk layout, manifests, and integrity rules. Follow the packaging guide so every compatible shell can install your bundle:

Atom MODULES.md

Store listing fields

When you publish, Atom Apps stores marketing fields separately from the registry index:

  • Title — what owners see first
  • Description — one clear paragraph of value
  • Categories — discovery tags
  • Instructions — optional setup notes on the detail page
  • Pricing — free, or paid with a price in cents

Checklist before upload

  1. Zip builds and loads in a local Atom shell.
  2. Module id and version are final for this release.
  3. Description sells the outcome, not the implementation.
  4. For paid modules, finish Connect onboarding first.