Reduce the overhead when creating project repositories by using this readme generator. A Node.js-based CLI to streamline the process of making professional project README files.
git clone
this repository. npm i
to intall the dependencies from ./package.json
, etc. inquirer
To run this Node.js CLI, navigate to the repository's root directory and execute the following command, node index.js
. Follow the prompts to add your GitHub information and project details. You may view the output file located at ./dist/README.md
Not taking pull requests at the moment.
To get in touch, see below:
-
GitHub Profile: @scottrohrig
-
Email: scott.rohrig@gmail.com
-
Project Repository/URL: https://github.com/scottrohrig/readme-gen