Skip to content

Commit 4d454ef

Browse files
committed
Update README to enhance clarity and add demo examples
1 parent a0d3f5e commit 4d454ef

File tree

1 file changed

+24
-22
lines changed

1 file changed

+24
-22
lines changed

README.md

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
1-
# APM CLI - Agent Package Manager
1+
# Agent Package Manager - npm for Agents
22

33
[![PyPI version](https://badge.fury.io/py/apm-cli.svg)](https://badge.fury.io/py/apm-cli)
44
[![CI/CD Pipeline](https://github.com/danielmeppiel/apm/actions/workflows/build-release.yml/badge.svg)](https://github.com/danielmeppiel/apm/actions/workflows/build-release.yml)
55
[![Downloads](https://img.shields.io/pypi/dm/apm-cli.svg)](https://pypi.org/project/apm-cli/)
66
[![GitHub stars](https://img.shields.io/github/stars/danielmeppiel/apm.svg?style=social&label=Star)](https://github.com/danielmeppiel/apm/stargazers)
77

8-
**Package Agentic workflows and Agent context as code** - Like npm for JavaScript, but for AI development components.
8+
**Stop copy-pasting prompts and instructions. Start packaging them.**
9+
10+
✅ Works with **GitHub Copilot, Cursor, Claude, Codex, Gemini, VSCode, Aider and all [AGENTS.md](https://agents.md) supporting agents**
11+
**2-minute setup** - zero config
12+
**Team collaboration** - composable context, without wheel reinvention
13+
14+
**Compound innovation** - reuse [packages built with APM by the community](#built-with-apm)
915

1016
## What Goes in Packages
1117

@@ -14,19 +20,8 @@
1420
- **Agents** - Agentic workflows (.prompt.md files)
1521
- **Context** - Company rules, standards, knowledge (.instructions.md files) and domain boundaries (.chatmode.md)
1622

17-
## Real Examples
18-
1923
![APM Demo](docs/apm-demo.gif)
2024

21-
**APM Packages** (reusable modules):
22-
- 🏢 [`compliance-rules`](https://github.com/danielmeppiel/compliance-rules) - GDPR contexts + audit workflows
23-
- 👤 [`design-guidelines`](https://github.com/danielmeppiel/design-guidelines) - Accessibility rules + UI review workflows
24-
25-
**Application using APM**:
26-
- 🚀 **[Corporate Website](https://github.com/danielmeppiel/corporate-website)** - Complete showcase demonstrating Context Optimization Engine + both packages above as dependencies
27-
28-
**Result**: Your Agents work consistently and follow your team's rules across all projects.
29-
3025
## Quick Start (2 minutes)
3126

3227
> [!NOTE]
@@ -99,15 +94,6 @@ apm deps list # List installed APM dependencies
9994
apm run <workflow> # Execute Agent workflows
10095
```
10196

102-
## Why APM?
103-
104-
Replace inconsistent prompting with engineered context + workflows:
105-
106-
**❌ Before**: "Add authentication" → unpredictable results across team members
107-
**✅ With APM**: Shared context + structured workflows → consistent, compliant outcomes
108-
109-
**The Power**: Your AI agents know your company's security standards, design guidelines, and compliance requirements **before** they start coding.
110-
11197
## Installation Options
11298

11399
### Homebrew
@@ -123,6 +109,22 @@ pip install apm-cli
123109

124110
[See complete installation guide](docs/getting-started.md) for all options and troubleshooting.
125111

112+
## Demo Example
113+
114+
**APM Packages** (reusable modules):
115+
- 🏢 [`compliance-rules`](https://github.com/danielmeppiel/compliance-rules) - GDPR contexts + audit workflows
116+
- 👤 [`design-guidelines`](https://github.com/danielmeppiel/design-guidelines) - Accessibility rules + UI review workflows
117+
118+
**Application using APM**:
119+
- 🚀 **[Corporate Website](https://github.com/danielmeppiel/corporate-website)** - Complete showcase demonstrating Context Optimization Engine + both packages above as dependencies
120+
121+
## 🌟 Built with APM
122+
123+
*Copy this badge for your APM projects* [![Built with APM](https://img.shields.io/badge/📦_Built_with-APM-blue?style=flat-square)](https://github.com/danielmeppiel/apm)
124+
125+
- 🏢 [Platform Mode](https://github.com/DevExpGbb/platform-mode) - The Future of AI-Enhanced Platform Engineering
126+
- [Add yours here!](https://github.com/danielmeppiel/apm/discussions/new)
127+
126128
## Next Steps
127129

128130
- 📖 [Complete Documentation](docs/index.md) - Deep dive into APM

0 commit comments

Comments
 (0)