Skip to content

Commit d0f997b

Browse files
committed
docs: restructure README with enhanced styling and organization
- Add banner image at top of README as primary visual element - Reorganize demo assets with versioning (demo.legacy.v1.gif, demo.legacy.v2.gif) - Add early development notice as blockquote after demo - Simplify supported AI engines table to two-column format with hyperlinks - Replace emojis with ANSI symbols (✓, ⊙) for cleaner professional look - Fix table centering for Supported AI Engines and References sections - Add styled References section with links to docs, spec schema, and case study - Move detailed contributor info to CONTRIBUTORS.md - Centralize and streamline Contributors section with contribution call-to-action - Add package manager alternatives (bun/pnpm/yarn) to installation instructions - Add 'cm' shortcut alias to run command - Improve overall visual consistency and navigation throughout README
1 parent 04832d9 commit d0f997b

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010
<p align="center">
1111
<strong>CodeMachine</strong> is a CLI-native Orchestration Engine that runs coordinated multi-agent workflows directly on your local machine. It provides the runtime infrastructure to execute complex multi-agent topologies within your own environment. Designed to drive any high-level autonomous objective, it features a battle-tested Spec-to-Code blueprint—transforming your terminal into a factory for production-ready software. ⚡️<br></p>
1212

13+
> **⚠️ Early Development Notice:** This project is in early development and is not yet ready for production use. Features may change, break, or be incomplete.
14+
1315
<p align="center">
1416
<img src="docs/assets/demo.gif" alt="CodeMachine in Action" width="800">
1517
</p>
@@ -24,7 +26,6 @@
2426
This isn't a demo—it's proof. CodeMachine engine orchestrated its own architecture, planning, implementation, and testing—creating a massively scalable codebase ready for continuous updates and improvements.
2527
</p>
2628

27-
2829
---
2930

3031
## Why CodeMachine?
@@ -39,14 +40,14 @@
3940

4041
### **Installing and running CodeMachine CLI**
4142

42-
First, install the command-line tool globally via npm:
43+
First, install the command-line tool globally:
4344
```bash
44-
npm install -g codemachine
45+
npm install -g codemachine # or bun/pnpm/yarn
4546
```
4647

47-
Then, simply run `codemachine` in your project directory to get started.
48+
Then, simply run `codemachine` in your project directory to get started:
4849
```bash
49-
codemachine
50+
codemachine # or cm
5051
```
5152

5253
### **Initializing a Project**
@@ -63,7 +64,7 @@ codemachine
6364
CodeMachine requires at least one CLI-based AI engine to handle the primary roles of planning and writing code, and is designed to orchestrate multiple engines to collaborate within a single workflow.
6465

6566
<p align="center">
66-
<table>
67+
<table align="center">
6768
<thead>
6869
<tr>
6970
<th align="left">CLI Engine</th>
@@ -195,7 +196,7 @@ Found a bug or have a feature idea? Check our <strong><a href="./CONTRIBUTING.md
195196
## 📖 References
196197

197198
<p align="center">
198-
<table>
199+
<table align="center">
199200
<tbody>
200201
<tr>
201202
<td align="center" width="33%">

docs/assets/demo.gif

638 KB
Loading

0 commit comments

Comments
 (0)