@alangreene/readme
An opinionated README.md generator.
This will read the package.json from the current directory and generate a README.md file containing relevant details with some suggested content and placeholders that you can edit to suit your project.
Usage
npx @alangreene/readme
This currently supports npm packages (i.e. requires a package.json file in the current directory). In future this may be expanded to support other uses.
This README was bootstrapped using this package.
Contributing
Contributions are welcome, whether code, documentation, reviews, etc. Read below to learn how you can help improve @alangreene/readme.
Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes.
We have a list of good first issues and help wanted issues which are a great place to get started.