readme-wiz
v1.2.5
Published
A CLI tool to auto-generate professional README.md files using GitHub markdown syntax
Maintainers
Keywords
Readme
⚠️ This is a CLI tool. Please install it globally using:
npm install -g readme-wiz
readme-wiz
🧙 A CLI to auto-generate professional
README.mdfiles using AI and code analysis.
✨ Features
- Parses code in multiple languages to extract project insights.
- Uses AI to generate markdown-formatted
README.mdfiles. - Easily configurable via prompts or flags.
- Supports Git-based contributor detection.
🚀 Installation
npm install -g readme-wiz🛠️ Usage
Generate a new README file in the current directory:
make-readmeThe following options are available:
| Command | Description |
| ---------------------------------------- | ----------------------------------------------------------------------------------------------- |
| make-readme | Creates a new README file using default settings. Overwrites existing README. |
| make-readme --new | Creates a completely new README file. Overwrites existing README. |
| make-readme --new "some user requests" | Creates a new README file incorporating specified user requests. Overwrites existing README. |
| make-readme "some user requests" | Updates an existing README file with specified user requests. Creates a new one if none exists. |
🧪 Requirements
- Node.js >=14
- Google Gemini API Key (set in .env)
