Welcome to readme-generator 👋

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

Example of package.json with good meta data:

// The package.json is not required to run README-GENERATOR
{
  "name": "readme-generator",
  "version": "0.1.3",
  "description": "CLI that generates beautiful README files.",
  "author": "Franck Abgrall",
  "license": "MIT",
  "homepage": "https://github.com/kefranabg/readme-generator#readme",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/kefranabg/readme-generator.git"
  },
  "bugs": {
    "url": "https://github.com/kefranabg/readme-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-generator

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

npx readme-generator -y

Use your own ejs README template (-p):

npx readme-generator -p path/to/my/owner/template

You can find ejs README template examples here.

Individuals

🤝 Contributing

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

Show your support

Please ⭐️ this repository if this project helped you!

📝 License

This project is MIT licensed.

---

This README was generated with ❤️ by readme-generator