https://github.com/donavon/init-readme

An opinionated README.md generator for npm utility packages
https://github.com/donavon/init-readme

readme readme-boilerplate readme-generator readme-template

Last synced: 4 months ago
JSON representation

An opinionated README.md generator for npm utility packages

• Host: GitHub
• URL: https://github.com/donavon/init-readme
• Owner: donavon
• License: mit
• Created: 2019-01-17T01:12:36.000Z (over 6 years ago)
• Default Branch: develop
• Last Pushed: 2019-01-17T01:21:06.000Z (over 6 years ago)
• Last Synced: 2025-06-14T19:38:16.929Z (4 months ago)
• Topics: readme, readme-boilerplate, readme-generator, readme-template
• Language: JavaScript
• Homepage:
• Size: 3.91 KB
• Stars: 11
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# init-readme

An opinionated README.md generator for npm utility packages.

[![npm version](https://badge.fury.io/js/init-readme.svg)](https://badge.fury.io/js/init-readme)

Do you create a lot of npm packages?

Do you find yourself going back to scratch to create each README.md?

Well no more.

## Create a new project

```bash

$ mkdir my-package

$ cd my-package

$ npm init

$ npx init-readme

```

This will read your `package.json` and auto generate a README.md file

that you can then edit with the specifics.

## License

**[MIT](LICENSE)** Licensed