readme-md-generator

Welcome to readme-md-generator 👋

CLI that generates beautiful README.md files.
readme-md-generator will suggest you default answers by reading your package.json and git configuration.

✨ Demo

readme-md-generator is able to read your environment (package.json, git config...) to suggest you default answers during the README.md creation process:

Generated README.md:

Example of package.json with good meta data:

// The package.json is not required to run README-MD-GENERATOR
{
  "name": "readme-md-generator",
  "version": "0.1.3",
  "description": "CLI that generates beautiful README.md files.",
  "author": "Franck Abgrall",
  "license": "MIT",
  "homepage": "https://github.com/kefranabg/readme-md-generator#readme",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/kefranabg/readme-md-generator.git"
  },
  "bugs": {
    "url": "https://github.com/kefranabg/readme-md-generator/issues"
  },
  "engines": {
    "npm": ">=5.5.0",
    "node": ">=9.3.0"
  }
}

🚀 Usage

Make sure you have npx installed (npx is shipped by default since npm 5.2.0)

Just run the following command at the root of your project and answer questions:

npx readme-md-generator

Or use default values for all questions (-y):

npx readme-md-generator -y

Use your own ejs README template (-p):

npx readme-md-generator -p path/to/my/own/template.md

You can find ejs README template examples here.

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

🤝 Contributing

Contributions, issues and feature requests are welcome.
Feel free to check issues page if you want to contribute.
Check the contributing guide.

Author

👤 Franck Abgrall

• Twitter: @FranckAbgrall
• Github: @kefranabg

Show your support

Please ⭐️ this repository if this project helped you!

📝 License

Copyright © 2019 Franck Abgrall.
This project is MIT licensed.

---

This README was generated with ❤️ by readme-md-generator

Changelog

1.0.0 (2019-12-03)

Added

• ✨ Ask for package manager when is JS project [29986ce]
• ✨ Ask user for a link to contributing guide (fixes #168) (#179) [310a8b1]
• ✨ Ask author's linkedin username (fixes #170) (#177) [10954d1]

Changed

• ⬆️ Update yargs to the latest version (#186) [16d7ceb]
• ⬆️ Update ejs to the latest version (#187) [139e906]
• 🔧 Update CI tiggers (#184) [6ef2be8]
• ⬆️ Update ora to the latest version (#181) [c563d9d]
• 🔧 Move CI from CircleCI to GitHub actions [a132525]
• 🔧 Update FUNDING.yml [83be6c0]

Fixed

• 🐛 Fix version badge label when contains _ or - (#190) [6c345b5]
• 🐛 Execute default function to get default answer when -y flag is passed (#185) [89cd82d]
• 🐛 Escape markdown characters in social network questions answers (#183) [d96e310]
• ✏️ Use gender neutral in comment (#174) [9f78778]
• 🐛 Fix InstallCommand test name [279711f]

Miscellaneous

• 📝 Add open collective to readme (#192) [81e3873]
• 📝 Add anku255 as a contributor for test and bug (#182) [7624889]

<a name="0.7.0"></a>