diff --git a/docs/README.md b/docs/README.md index 2160a06eb..fe111397d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -15,6 +15,7 @@ Welcome to the Agent Package Manager documentation. Choose your path: - **[CLI Reference](cli-reference.md)** - Complete command documentation - **[Examples & Use Cases](examples.md)** - Real-world patterns - **[Integration Guide](integrations.md)** - VSCode, AI runtimes, tools +- **[Template Ecosystem](templates.md)** - Community templates via npm ## šŸ”§ **Advanced** - **[Runtime Integration](runtime-integration.md)** - Codex and LLM setup diff --git a/docs/templates.md b/docs/templates.md new file mode 100644 index 000000000..66a7ac38e --- /dev/null +++ b/docs/templates.md @@ -0,0 +1,279 @@ +# APM Template Ecosystem + +This document describes the community-driven template ecosystem for APM, following npm's initializer pattern (`npm init `). + +## Overview + +APM templates are distributed as npm packages named `create-apm-`. This allows: + +- **Community ownership** - Anyone can publish templates +- **Standard tooling** - Uses npm/npx (no new tools) +- **Versioning** - Templates evolve independently via semver +- **Discoverability** - Standard npm search works + +## Using Templates + +### Basic Usage + +```bash +# Run a template +apm init [project-name] + +# Examples: +apm init hello-world my-app # → npx create-apm-hello-world my-app +apm init express-api my-api # → npx create-apm-express-api my-api +apm init compliance # → npx create-apm-compliance (current dir) +``` + +### How It Works + +When you run `apm init