mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
e0318d9da8
* docs: apply style guide to TEA Lite quickstart - Remove duplicate H1 header (frontmatter provides title) - Remove horizontal rules throughout - Convert Prerequisites to admonition - Add Quick Path TL;DR admonition - Convert Key Takeaway to tip admonition - Convert TEA Workflows list to Quick Reference table - Convert Troubleshooting to Common Questions FAQ format - Rename Need Help to Getting Help section - Remove redundant Feedback section Also adds missing @clack/prompts dependency from upstream merge. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: spell out acronyms in TEA Lite quickstart - MCP → Model Context Protocol - E2E → End-to-end (also fix missing article) - CI/CD → Continuous integration/continuous deployment - ATDD → Acceptance Test-Driven Development - TDD → Test-Driven Development - NFR → non-functional requirements - Remove inaccurate CRUD reference Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: spell out TDD in ATDD link text Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat: update branding with new wordmark logo and banner - Add banner image to README header - Replace website logo with wordmark, hiding title text - Left-align logo with sidebar by reducing header padding Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: update README banner to new design with waveform Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat: add banner to docs website welcome page - Revert README to original banner - Add waveform banner to docs site welcome page Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat: use waveform banner as website header logo - Remove banner from welcome page content - Update header logo to use banner-bmad-method2.png Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat: add separate logo for dark mode Use banner-bmad-method-dark.png in dark mode for better blending Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat: update header logos for light and dark modes - Light mode: bmad-light.png (dark blue background with lightning) - Dark mode: bmad-dark.png (light background variant) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * chore: clean up unused banner images and add readme2 - Remove unused banner-bmad-method2.png and bmad-wordmark.png - Add readme2.md with upcoming features section - Update banner-bmad-method-dark.png Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * chore: remove unused banner image variants Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat: finalize header logo graphics - Rename bmad-light2.png to bmad-light.png as final version - Remove readme2.md draft Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Co-authored-by: Brian <bmadcode@gmail.com>
92 lines
4.2 KiB
Markdown
92 lines
4.2 KiB
Markdown
|
|
|
|
[](https://www.npmjs.com/package/bmad-method)
|
|
[](LICENSE)
|
|
[](https://nodejs.org)
|
|
[](https://discord.gg/gk8jAdXWmj)
|
|
|
|
**Build More, Architect Dreams** — An AI-driven agile development framework with 21 specialized agents, 50+ guided workflows, and scale-adaptive intelligence that adjusts from bug fixes to enterprise systems.
|
|
|
|
**100% free and open source.** No paywalls. No gated content. No gated Discord. We believe in empowering everyone, not just those who can pay.
|
|
|
|
## Why BMad?
|
|
|
|
Traditional AI tools do the thinking for you, producing average results. BMad agents act as expert collaborators who guide you through structured workflows to bring out your best thinking.
|
|
|
|
- **Scale-Adaptive**: Automatically adjusts planning depth based on project complexity (Level 0-4)
|
|
- **Structured Workflows**: Grounded in agile best practices across analysis, planning, architecture, and implementation
|
|
- **Specialized Agents**: 12+ domain experts (PM, Architect, Developer, UX, Scrum Master, and more)
|
|
- **Complete Lifecycle**: From brainstorming to deployment, with just-in-time documentation
|
|
|
|
## Quick Start
|
|
|
|
**Prerequisites**: [Node.js](https://nodejs.org) v20+
|
|
|
|
```bash
|
|
npx bmad-method@alpha install
|
|
```
|
|
|
|
Follow the installer prompts to configure your project. Then run:
|
|
|
|
```bash
|
|
*workflow-init
|
|
```
|
|
|
|
This analyzes your project and recommends a track:
|
|
|
|
| Track | Best For | Time to First Story |
|
|
| --------------- | ------------------------- | ------------------- |
|
|
| **Quick Flow** | Bug fixes, small features | ~5 minutes |
|
|
| **BMad Method** | Products and platforms | ~15 minutes |
|
|
| **Enterprise** | Compliance-heavy systems | ~30 minutes |
|
|
|
|
## Modules
|
|
|
|
| Module | Purpose |
|
|
| ------------------------------------- | -------------------------------------------------------- |
|
|
| **BMad Method (BMM)** | Core agile development with 34 workflows across 4 phases |
|
|
| **BMad Builder (BMB)** | Create custom agents and domain-specific modules |
|
|
| **Creative Intelligence Suite (CIS)** | Innovation, brainstorming, and problem-solving |
|
|
|
|
## Documentation
|
|
|
|
**[Full Documentation](http://docs.bmad-method.org)** — Tutorials, how-to guides, concepts, and reference
|
|
|
|
- [Getting Started Tutorial](http://docs.bmad-method.org/tutorials/getting-started/getting-started-bmadv6/)
|
|
- [Upgrading from Previous Versions](http://docs.bmad-method.org/how-to/installation/upgrade-to-v6/)
|
|
|
|
### For v4 Users
|
|
|
|
- **[v4 Documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4/docs)**
|
|
|
|
## Community
|
|
|
|
- [Discord](https://discord.gg/gk8jAdXWmj) — Get help, share ideas, collaborate
|
|
- [YouTube](https://www.youtube.com/@BMadCode) — Tutorials, master class, and podcast (launching Feb 2025)
|
|
- [GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) — Bug reports and feature requests
|
|
- [Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions) — Community conversations
|
|
|
|
## Support BMad
|
|
|
|
BMad is free for everyone — and always will be. If you'd like to support development:
|
|
|
|
- ⭐ [Star us on GitHub](https://github.com/bmad-code-org/BMAD-METHOD/) — Helps others discover BMad
|
|
- 📺 [Subscribe on YouTube](https://www.youtube.com/@BMadCode) — Master class launching Feb 2026
|
|
- ☕ [Buy Me a Coffee](https://buymeacoffee.com/bmad) — Fuel the development
|
|
- 🏢 Corporate sponsorship — DM on Discord
|
|
- 🎤 Speaking & Media — Available for conferences, podcasts, interviews (Discord)
|
|
|
|
## Contributing
|
|
|
|
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
|
|
|
## License
|
|
|
|
MIT License — see [LICENSE](LICENSE) for details.
|
|
|
|
---
|
|
|
|
**BMad** and **BMAD-METHOD** are trademarks of BMad Code, LLC.
|
|
|
|
[](https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors)
|