ai-workflow-init 1.0.0 → 1.1.0

package/README.md

@@ -1,58 +1,30 @@
-# AI DevKit Workflow Quick Start
+# AI Workflow Installer (npx)
 
-This repository contains standardized project documentation, workflow templates, and AI agent configuration for structured development in any codebase.
+Initialize standardized AI workflow docs and command templates into ANY repository with ONE command.
 
-## How to Integrate into Any Project
+## Quick Start
 
-You have two methods to quickly add the workflow docs & agent commands into ANY repo:
+> Requires: [Node.js](https://nodejs.org/) (>= 14)
 
----
-
-## 1. Using degit (**Recommended, cross-platform**)
-
-> **Requires:** [Node.js](https://nodejs.org/) (includes npx & degit on Windows, Ubuntu, Mac)
-
-**Step 1:** Install degit *(optional—can use npx degit directly)*
-```bash
-npm install -g degit
-```
-
-**Step 2:** Run (in your target repo root):
-```bash
-npx degit your-username/ai-devkit-workflow-template/docs/ai docs/ai
-npx degit your-username/ai-devkit-workflow-template/.cursor/commands .cursor/commands
-```
-- This will copy all workflow docs and AI command templates to the current project.
-- Compatible with Windows Powershell, CMD, GitBash, WSL, Ubuntu/macOS terminals.
-
----
-
-## 2. Using npx script (when available)
-
-> **Requires:** Node.js (>= v14). No other global install required.
-
-When a published init package is available, just run:
+Run in the root of your target project:
 ```bash
-npx @your-org/ai-devkit-workflow-init
+npx ai-workflow-init
 ```
-- The script will automatically fetch the workflow files and set up your repo.
-
----
-
-## 3. Manual method (fallback)
+This will automatically fetch and place:
+- `docs/ai` (planning, implementation, testing, project standards)
+- `.cursor/commands` (AI agent commands)
+- `AGENTS.md`
 
-Clone this repo and copy files:
-```bash
-git clone https://github.com/your-username/ai-devkit-workflow-template.git ai-template-tmp
-cp -r ai-template-tmp/docs/ai ./docs/
-cp -r ai-template-tmp/.cursor/commands ./.cursor/
-rm -rf ai-template-tmp
-```
-
----
 ## Notes
-- All commands work identically on Windows, Ubuntu, Mac if Node.js is installed.
-- If you want to contribute updates to templates, fork this repo!
-
----
-*See INTEGRATE.md in this repo for more advanced integration and troubleshooting.*
+- Works on Windows (PowerShell/CMD/Git Bash), macOS, and Linux.
+- If the destination folders already exist, the installer will overwrite files as needed.
+- After installation, commit the new files to your repository so your team can use them.
+
+## What gets installed
+- Documentation templates and guides under `docs/ai/`
+- AI agent commands under `.cursor/commands/`
+- `AGENTS.md` with rules and workflow overview
+
+## Troubleshooting
+- Ensure Node.js is installed and accessible in your PATH.
+- If your network blocks npm registry calls, try again on a different network or with a VPN.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai-workflow-init",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Initialize AI workflow docs & commands into any repo with one command",
   "bin": {
     "ai-workflow-init": "./cli.js"
@@ -12,11 +12,17 @@
     "url": "git+https://github.com/phananhtuan09/ai-agent-workflow.git"
   },
   "homepage": "https://github.com/phananhtuan09/ai-agent-workflow#readme",
-  "keywords": ["ai", "workflow", "docs", "degit", "init"],
+  "keywords": [
+    "ai",
+    "workflow",
+    "docs",
+    "degit",
+    "init"
+  ],
   "dependencies": {
     "degit": "^2.8.4"
   },
   "engines": {
     "node": ">=14"
   }
-}
+}