Professional and reusable README templates for GitHub projects.
Create stunning documentation in minutes with our multilingual templates (EN/PT/ES).
🇧🇷 Português | 🇪🇸 Español | 🌐 Live Dashboard
Awesome Readme Templates helps you create professional documentation for your projects without the hassle of writing everything from scratch. Choose from a variety of templates and get started instantly.
- Multilingual Support: Ready-to-use templates in English, Portuguese (PT-BR), and Spanish (ES).
- CLI Generator: Interactive command-line tool
awesome-readmeto easily setup your docs. - Variable Replacement: Automatic substitution of
[PROJECT_NAME],[AUTHOR_NAME], etc. - Multiple Styles: Choose between Professional, Minimalist, and more styles for your README.
- Extensible: Modular design allowing easy addition of new sections and templates.
- Zero Dependencies: Lightweight and fast, built with pure Node.js.
- Framework: Node.js
- Language: JavaScript (ESM)
- Libraries: Native Node.js modules (fs, path, readline).
- Structure: Modular architecture with centralized configuration.
Installation is simple and straightforward via npm.
-
Install with npx:
npx awesome-readme-templates
This will immediately start the interactive CLI.
-
Global Installation:
npm install -g awesome-readme-templates awesome-readme
-
Check Installation: Run
awesome-readme --helpto see available options.
Awesome Readme Templates allows you to choose exactly what you need:
- Run
npx awesome-readme-templates. - Select Interactive Selection.
- Choose your preferred language (English, Portuguese, or Spanish).
- Fill in your project details (Name, Description, Author) for automatic replacement.
- Select the README style (Standard, Minimalist, or Complete).
- Select the templates you want (Contributing, Changelog, etc.).
- Confirm and write files to your project.
- Use CLI flags to skip menus:
awesome-readme --main-lang es --all
- Or specify languages, templates, and license:
awesome-readme --main-lang pt --langs en,es --with-github --license mit
- README.md: Complete project documentation.
- CONTRIBUTING.md: Guidelines for contributors.
- CHANGELOG.md: History of changes.
- CODE_OF_CONDUCT.md: Community standards.
- SECURITY.md: Security policies.
- GitHub Files: PR templates, Issue templates, Funding, etc.
If you want to clone the repository and run the project locally:
# 1. Clone the repository
git clone https://github.com/GabrielBaiano/awesome-readme.git
# 2. Navigate to the project folder
cd awesome-readme
# 3. Install dependencies
npm install
# 4. Run in development mode
npm start
# 5. To create installers (if applicable) or test CLI locally
npm link
awesome-readmeContributions are welcome! Feel free to submit a Pull Request. Check out our CONTRIBUTING.md for more details.
This project is licensed under the MIT License.
Made with ❤️ by GabrielBaiano!
