ros/BMAD-METHOD
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updates to doc and package

Browse Source
This commit is contained in:
Brian Madison
2025-06-14 20:39:46 -05:00
parent 2e4f9f0210
commit 1913aeec0a
2 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -3,7 +3,7 @@
[![Version](https://img.shields.io/npm/v/bmad-method?color=blue&label=version)](https://www.npmjs.com/package/bmad-method) [![Version](https://img.shields.io/npm/v/bmad-method?color=blue&label=version)](https://www.npmjs.com/package/bmad-method)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
[![Node.js Version](https://img.shields.io/badge/node-%3E%3D14.0.0-brightgreen)](https://nodejs.org) [![Node.js Version](https://img.shields.io/badge/node-%3E%3D14.0.0-brightgreen)](https://nodejs.org)
[![Discord](https://img.shields.io/badge/Discord-Join%20Community-7289da?logo=discord&logoColor=white)](https://discord.gg/YOUR_ACTUAL_DISCORD_INVITE) [![Discord](https://img.shields.io/badge/Discord-Join%20Community-7289da?logo=discord&logoColor=white)](https://discord.gg/g6ypHytrCB)
**AI-Powered Agile Development Framework** - Transform your software development with specialized AI agents that work as your complete Agile team. **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) **Prerequisites**: Install [Node.js](https://nodejs.org) (v14 or higher)
```bash ````bash
npx bmad-method install npx bmad-method install
# The installer will automatically detect your project state and guide you through: # The installer will automatically detect your project state and guide you through:
# - Fresh installation or upgrade from v3 # - Fresh installation or upgrade from v3
@@ -86,7 +86,7 @@ npx bmad-method install
# Or use command line options for fresh installations # Or use command line options for fresh installations
npx bmad-method install --full --directory ./my-project --ide cursor npx bmad-method install --full --directory ./my-project --ide cursor
npx bmad-method install --agent pm --directory ./my-project --ide claude-code npx bmad-method install --agent pm --directory ./my-project --ide claude-code
``` ````
**Supported IDEs:** **Supported IDEs:**
@@ -126,7 +126,7 @@ The BMad Method works with any IDE, but has built-in integration for:
After installation with `--ide` flag: After installation with `--ide` flag:
```bash ````bash
# In Cursor # In Cursor
@pm Create a PRD for a task management app @pm Create a PRD for a task management app
@@ -152,13 +152,13 @@ npx bmad-method install
# Check installation status # Check installation status
npx bmad-method status npx bmad-method status
``` ````
### Upgrading from V3 to V4 ### Upgrading from V3 to V4
If you have an existing BMAD-METHOD V3 project, simply run the installer in your project directory: If you have an existing BMAD-METHOD V3 project, simply run the installer in your project directory:
```bash ````bash
npx bmad-method install npx bmad-method install
# The installer will automatically detect your V3 installation and offer to upgrade # The installer will automatically detect your V3 installation and offer to upgrade
```text ```text
@@ -217,7 +217,7 @@ tools/
└── lib/ # Build utilities └── lib/ # Build utilities
expansion-packs/ # Optional add-ons (DevOps, Mobile, etc.) expansion-packs/ # Optional add-ons (DevOps, Mobile, etc.)
``` ````
## Advanced Features ## Advanced Features

6
package.json
View File

@@ -4,8 +4,8 @@
"description": "Breakthrough Method of Agile AI-driven Development", "description": "Breakthrough Method of Agile AI-driven Development",
"main": "tools/cli.js", "main": "tools/cli.js",
"bin": { "bin": {
"bmad": "./tools/bmad-npx-wrapper.js", "bmad": "tools/bmad-npx-wrapper.js",
"bmad-method": "./tools/bmad-npx-wrapper.js" "bmad-method": "tools/bmad-npx-wrapper.js"
}, },
"scripts": { "scripts": {
"build": "node tools/cli.js build", "build": "node tools/cli.js build",
@@ -45,7 +45,7 @@
"license": "MIT", "license": "MIT",
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://github.com/bmadcode/BMAD-METHOD.git" "url": "git+https://github.com/bmadcode/BMAD-METHOD.git"
}, },
"engines": { "engines": {
"node": ">=14.0.0" "node": ">=14.0.0"