@arrislink/axon 1.0.0 → 1.0.2

package/README.md

@@ -8,27 +8,52 @@
 [![Bun](https://img.shields.io/badge/bun-%3E=1.1.0-blue.svg)](https://bun.sh)
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.3-blue.svg)](https://www.typescriptlang.org)
 
-Axon is a unified AI-assisted development environment that solves context loss, wheel reinvention, and planning chaos in AI-powered programming through deep integration of specification-driven development, task management, and skill reuse.
+Axon is a unified AI-assisted development environment that solves context loss, wheel reinvention, and planning chaos in AI-powered programming. **Powered by [OpenCode](https://github.com/anomalyco/opencode) and [OhMyOpenCode](https://github.com/code-yeongyu/oh-my-opencode)**, Axon orchestrates these powerful tools through specification-driven development and task management.
 
-## ✨ Features
+## ✨ Why Axon?
 
-- **📝 Spec-Driven Development** - Define clear requirements before coding
-- **🔗 Task Traceability** - Every line of code maps to a specific task bead
-- **🎯 Knowledge Reuse** - Automatically match and apply validated skill templates
-- **💰 Cost Control** - Smart token usage tracking to prevent overspending
-- **🤖 Multi-Provider Support** - Integrate with OMO for 75+ LLM providers (Anthropic, OpenAI, Antigravity, etc.)
-- **🎭 Agent Orchestration** - Multiple AI agents collaborate intelligently
+**Axon transforms AI from a "Code Autocompleter" into a "Development Partner".**
+
+- **🧠 Spec-First**: Don't just chat. Define requirements in `spec.md` to keep the AI focused.
+- **🗺️ Bead Planning**: Complex features are broken into atomic, dependency-sorted tasks (Beads).
+- **🤖 Agentic Execution**: **OpenCode** agents execute tasks one-by-one, ensuring context and quality.
+- **♻️ Skill Reuse**: Automatically apply proven patterns (e.g., "Secure Auth") from your team's library.
+- **🛡️ Enterprise Safe**: Token budgeting, Git safety checks, and multi-provider failover via **OMO**.
+
+## 🎯 Applicable Scenarios
+
+Axon is best suited for:
+
+- **Complex Feature Implementation**: When a feature requires multiple file changes and architectural consistency (e.g., "Add JWT Auth").
+- **Greenfield Projects**: Starting a new project with clear requirements and strictly following a spec.
+- **Large-Scale Refactoring**: Systematically updating code patterns across a codebase.
+- **Team Standardization**: Enforcing consistent coding standards and capabilities across a team using shared Skill templates.
+
+It is **NOT** designed for:
+- Simple, one-line code completions (Use Copilot/Cursor).
+- Real-time syntax error fixing (Use IDE linters).
+
+## 🆚 Tool Comparison
+
+| Feature | Axon | GitHub Copilot / Cursor | Aider / OpenDevin |
+| :--- | :--- | :--- | :--- |
+| **Core Philosophy** | **Plan-Execute-Verify** (Agentic) | **Autocomplete** (Assistive) | **Chat-to-Code** (Autonomous) |
+| **Context Awareness** | **High** (Project-wide Spec + Graph) | **Medium** (Open Files + RAG) | **High** (Repo Map) |
+| **Planning** | ✅ **Pre-execution Task Graph** | ❌ None (Streaming) | ⚠️ Implicit (Step-by-step) |
+| **Human Control** | ✅ **High** (Review Plan & Spec) | ✅ High (Accept/Reject) | ⚠️ Application Dependent |
+| **Cost Control** | ✅ **Token Budgeting & Tracking** | ❌ Subscription Based | ⚠️ Often Unbounded |
+| **Knowledge Reuse** | ✅ **Skill Templates** (.skills) | ❌ None | ❌ None |
 
 ## 🚀 Quick Start
 
 ### Global Installation (Recommended)
 
 ```bash
-# Install globally via npm (coming soon)
-npm install -g axon
+# Install globally via npm
+npm install -g @arrislink/axon
 
 # Or use with bunx
-bunx axon init my-project
+bunx @arrislink/axon init my-project
 ```
 
 ### Development Installation
@@ -220,9 +245,8 @@ bun run build:js
 ```
 
 ## 📖 Documentation
-
-- [Product Requirements (PRD)](./PRD.md)
-- [API Documentation](./docs/api.md)
+ 
+- [**User Guide**](./docs/GUIDE.md) - **Start Here** (Philosophy, Arch, Features, API)
 - [Contributing Guide](./CONTRIBUTING.md)
 - [Changelog](./CHANGELOG.md)
 

package/README.zh-CN.md

@@ -8,27 +8,52 @@
 [![Bun](https://img.shields.io/badge/bun-%3E=1.1.0-blue.svg)](https://bun.sh)
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.3-blue.svg)](https://www.typescriptlang.org)
 
-Axon 是一个统一的 AI 辅助开发环境，通过深度集成规格驱动开发、任务管理和技能复用，解决 AI 编程中的上下文丢失、重复造轮子和规划失控问题。
+Axon 是一个统一的 AI 辅助开发环境，解决 AI 编程中的上下文丢失、重复造轮子和规划失控问题。**由 [OpenCode](https://github.com/anomalyco/opencode) 和 [OhMyOpenCode](https://github.com/code-yeongyu/oh-my-opencode) 驱动**，Axon 通过规格驱动开发和任务管理来编排这些强大的工具。
 
-## ✨ 核心特性
+## ✨ 为什么选择 Axon?
 
-- **📝 规格驱动开发** - 先定义清晰需求，再编码
-- **🔗 任务可追溯性** - 每行代码对应明确的任务珠子
-- **🎯 知识复用** - 自动匹配并应用已验证的技能模板
-- **💰 成本控制** - 智能追踪 token 消耗，避免超支
-- **🤖 多提供商支持** - 集成 OMO，支持 75+ LLM 提供商（Anthropic、OpenAI、Antigravity 等）
-- **🎭 Agent 编排** - 多个 AI 代理智能协作
+**Axon 将 AI 从“代码补全工具”转变为真正的“开发合作伙伴”。**
+
+- **🧠 规格优先**: 拒绝随意对话。在 `spec.md` 中定义需求，让 AI 保持专注。
+- **🗺️ 珠子规划**: 将复杂功能拆解为原子的、按依赖排序的任务 (Beads)。
+- **🤖 代理执行**: **OpenCode** 智能体逐个执行任务，确保上下文完整和代码质量。
+- **♻️ 技能复用**: 自动应用团队库中经过验证的模式 (如“安全认证”)。
+- **🛡️ 企业级安全**: Token 预算控制、Git 安全检查以及通过 **OMO** 实现的多模型故障转移。
+
+## 🎯 适用场景
+
+Axon 最适合以下场景：
+
+- **复杂功能实现**: 当功能需要修改多个文件并保持架构一致性时（例如“添加 JWT 认证”）。
+- **绿地项目**: 启动一个需求清晰且严格遵循规格的新项目。
+- **大规模重构**: 在代码库中系统地更新代码模式。
+- **团队标准化**: 使用共享的技能模板在团队中强制执行一致的编码标准和能力。
+
+它是与 **不适用** 于：
+- 简单的单行代码补全（请使用 Copilot/Cursor）。
+- 实时语法错误修复（请使用 IDE linter）。
+
+## 🆚 工具对比
+
+| 特性 | Axon | GitHub Copilot / Cursor | Aider / OpenDevin |
+| :--- | :--- | :--- | :--- |
+| **核心理念** | **规划-执行-验证** (代理式) | **自动补全** (辅助式) | **聊天即代码** (自主式) |
+| **上下文感知** | **高** (全项目规格 + 任务图) | **中** (打开文件 + RAG) | **高** (仓库地图) |
+| **规划能力** | ✅ **执行前任务图** | ❌ 无 (流式生成) | ⚠️ 隐式 (逐步进行) |
+| **人类控制** | ✅ **高** (审查规划与规格) | ✅ 高 (接受/拒绝) | ⚠️ 依赖于具体应用 |
+| **成本控制** | ✅ **Token 预算与追踪** | ❌ 基于订阅 | ⚠️ 通常无限制 |
+| **知识复用** | ✅ **技能模板** (.skills) | ❌ 无 | ❌ 无 |
 
 ## 🚀 快速开始
 
 ### 全局安装（推荐）
 
 ```bash
-# 通过 npm 全局安装（即将推出）
-npm install -g axon
+# 通过 npm 全局安装
+npm install -g @arrislink/axon
 
 # 或使用 bunx
-bunx axon init my-project
+bunx @arrislink/axon init my-project
 ```
 
 ### 开发安装
@@ -220,9 +245,8 @@ bun run build:js
 ```
 
 ## 📖 文档
-
-- [产品需求文档 (PRD)](./PRD.md)
-- [API 文档](./docs/api.md)
+ 
+- [**用户指南**](./docs/GUIDE.zh-CN.md) - **从这里开始** (设计理念, 架构, 功能, API)
 - [贡献指南](./CONTRIBUTING.md)
 - [更新日志](./CHANGELOG.md)