Skip to content

Commit 2c7059f

Browse files
Refactor headings and improve README formatting
Updated section headings and formatting in the README.
1 parent 9a936bc commit 2c7059f

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ AI DevKit is an open-source ecosystem designed to bridge the gap between human i
77
[![npm version](https://img.shields.io/npm/v/ai-devkit.svg)](https://www.npmjs.com/package/ai-devkit)
88
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
99

10-
## 🌟 Vision
10+
## Vision
1111

1212
The capabilities of AI coding agents are growing exponentially, but they often struggle with:
1313
1. **Context**: Losing track of broad project requirements and architectural decisions.
@@ -17,27 +17,27 @@ The capabilities of AI coding agents are growing exponentially, but they often s
1717
**AI DevKit** solves this by enforcing a **Phase-Based Development** lifecycle—ensuring agents follow the same rigorous engineering
1818
standards as senior developers: Requirements → Design → Planning → Implementation → Testing.
1919

20-
## 📦 Packages
20+
## Packages
2121

2222
AI DevKit is a monorepo containing multiple specialized tools:
2323

24-
### [🖥️ ai-devkit (CLI)](./packages/cli)
24+
### [ai-devkit (CLI)](./packages/cli)
2525
The command-line interface that orchestrates the development lifecycle.
2626
- **Scaffold** structured documentation (Requirements, Design, Plan).
2727
- **Configure** environments for Cursor, Claude Code, and other agents.
2828
- **Manage** project state and development phases.
2929

3030
[**Explore the CLI Docs →**](./packages/cli/README.md)
3131

32-
### [🧠 @ai-devkit/memory](./packages/memory)
32+
### [@ai-devkit/memory](./packages/memory)
3333
A lightweight MCP-based memory service that gives agents persistent, searchable long-term memory.
3434
- **Store** architectural decisions and coding patterns.
3535
- **Search** documentation and knowledge using full-text search.
3636
- **Share** context across different agents and sessions.
3737

3838
[**Explore the Memory Docs →**](./packages/memory/README.md)
3939

40-
## 🚀 Quick Start
40+
## Quick Start
4141

4242
To start using the core toolkit in your project instantly:
4343

@@ -47,7 +47,7 @@ npx ai-devkit init
4747

4848
This will launch the interactive setup wizard to configure your project for AI-assisted development.
4949

50-
## 🤝 Contributing
50+
## Contributing
5151

5252
We welcome contributions! Whether you're building a new agent integration, adding a memory adapter, or improving our templates.
5353

@@ -74,4 +74,3 @@ We use a monorepo structure. Ensure all changes are covered by tests before subm
7474
## License
7575

7676
MIT
77-

0 commit comments

Comments
 (0)