Professional and reusable README templates for GitHub projects.
Create stunning documentation in minutes with our bilingual templates (EN/PT).

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.

Check the live site here!

📚 Project Evolution: Started as a simple template collection, now evolved into a powerful CLI tool to scaffold documentation for any project.

• Bilingual Support: Ready-to-use templates in English and Portuguese (PT-BR).
• CLI Generator: Interactive command-line tool awesome-readme to easily setup your docs.
• 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.

1. Install with npx:

   npx awesome-readme-templates

   This will immediately start the interactive CLI.

2. Global Installation:

   npm install -g awesome-readme-templates
   awesome-readme

3. Check Installation: Run awesome-readme --help to see available options.

Awesome Readme Templates allows you to choose exactly what you need:

1. Run npx awesome-readme-templates.
2. Select Interactive Selection.
3. Choose your preferred language (English or Portuguese).
4. Select the templates you want (README, Contributing, Changelog, etc.).
5. Confirm and write files to your project.

1. Use CLI flags to skip menus.

   awesome-readme --lang=en --all

2. Or specify templates:

   awesome-readme --lang=pt --readme --contributing

• 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-readme

• Open Source Maintainers: Quickly standardize your repo docs.
• Freelancers: Deliver professional documentation to clients.
• Students: Learn best practices for project documentation.
• Teams: Ensure consistency across all company repositories.

Contributions 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