updates to doc and package
This commit is contained in:
14
README.md
14
README.md
@@ -3,7 +3,7 @@
|
||||
[](https://www.npmjs.com/package/bmad-method)
|
||||
[](LICENSE)
|
||||
[](https://nodejs.org)
|
||||
[](https://discord.gg/YOUR_ACTUAL_DISCORD_INVITE)
|
||||
[](https://discord.gg/g6ypHytrCB)
|
||||
|
||||
**AI-Powered Agile Development Framework** - Transform your software development with specialized AI agents that work as your complete Agile team.
|
||||
|
||||
@@ -24,7 +24,7 @@
|
||||
|
||||
**Prerequisites**: Install [Node.js](https://nodejs.org) (v14 or higher)
|
||||
|
||||
```bash
|
||||
````bash
|
||||
npx bmad-method install
|
||||
# The installer will automatically detect your project state and guide you through:
|
||||
# - Fresh installation or upgrade from v3
|
||||
@@ -86,7 +86,7 @@ npx bmad-method install
|
||||
# Or use command line options for fresh installations
|
||||
npx bmad-method install --full --directory ./my-project --ide cursor
|
||||
npx bmad-method install --agent pm --directory ./my-project --ide claude-code
|
||||
```
|
||||
````
|
||||
|
||||
**Supported IDEs:**
|
||||
|
||||
@@ -126,7 +126,7 @@ The BMad Method works with any IDE, but has built-in integration for:
|
||||
|
||||
After installation with `--ide` flag:
|
||||
|
||||
```bash
|
||||
````bash
|
||||
# In Cursor
|
||||
@pm Create a PRD for a task management app
|
||||
|
||||
@@ -152,13 +152,13 @@ npx bmad-method install
|
||||
|
||||
# Check installation status
|
||||
npx bmad-method status
|
||||
```
|
||||
````
|
||||
|
||||
### Upgrading from V3 to V4
|
||||
|
||||
If you have an existing BMAD-METHOD V3 project, simply run the installer in your project directory:
|
||||
|
||||
```bash
|
||||
````bash
|
||||
npx bmad-method install
|
||||
# The installer will automatically detect your V3 installation and offer to upgrade
|
||||
```text
|
||||
@@ -217,7 +217,7 @@ tools/
|
||||
└── lib/ # Build utilities
|
||||
|
||||
expansion-packs/ # Optional add-ons (DevOps, Mobile, etc.)
|
||||
```
|
||||
````
|
||||
|
||||
## Advanced Features
|
||||
|
||||
|
||||
@@ -4,8 +4,8 @@
|
||||
"description": "Breakthrough Method of Agile AI-driven Development",
|
||||
"main": "tools/cli.js",
|
||||
"bin": {
|
||||
"bmad": "./tools/bmad-npx-wrapper.js",
|
||||
"bmad-method": "./tools/bmad-npx-wrapper.js"
|
||||
"bmad": "tools/bmad-npx-wrapper.js",
|
||||
"bmad-method": "tools/bmad-npx-wrapper.js"
|
||||
},
|
||||
"scripts": {
|
||||
"build": "node tools/cli.js build",
|
||||
@@ -45,7 +45,7 @@
|
||||
"license": "MIT",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/bmadcode/BMAD-METHOD.git"
|
||||
"url": "git+https://github.com/bmadcode/BMAD-METHOD.git"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=14.0.0"
|
||||
|
||||
Reference in New Issue
Block a user