@ametyst/cli 0.2.0

package/README.md

@@ -0,0 +1,36 @@
+# <repo-name>
+
+> One-sentence summary of what this repo is. Example: "Credential service — handles auth, sessions, JWT issuance, and key management for Ametyst."
+
+## What this repo does
+- Bullet 1 — primary responsibility
+- Bullet 2 — secondary responsibility
+- Bullet 3 — secondary responsibility
+
+Stop here. Design decisions go in [ARCHITECTURE.md](ARCHITECTURE.md).
+
+## Quickstart (local)
+```bash
+gh repo clone ametyst-dev/<repo-name>
+cd <repo-name>
+pnpm install
+cp .env.example .env.local   # then fill values (ask in #product Slack if missing)
+docker compose up -d         # if this repo needs a local DB/Redis
+pnpm dev
+```
+
+App runs on `http://localhost:<port>`.
+
+## Docs
+- [ARCHITECTURE.md](ARCHITECTURE.md) — how the code is organized
+- [INFRA.md](INFRA.md) — how it gets deployed
+- [CONTRIBUTING.md](CONTRIBUTING.md) — how to develop and contribute
+- [CHANGELOG.md](CHANGELOG.md) — release notes
+
+## Related repos
+- `@ametyst-dev/sdk` — shared types and client
+- `<other dependencies>`
+
+## Owners
+- @<github-handle> (DRI)
+- @<github-handle> (backup)