init-readme

An opinionated README.md generator for npm utility packages.

Usage no npm install needed!

<script type="module">
  import initReadme from 'https://cdn.skypack.dev/init-readme';
</script>

README

init-readme

An opinionated README.md generator for npm utility packages.

npm version

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

$ 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 Licensed