By tan-x

Node.js CLI that generates a README markdown for your github project based off of user input.

• Javascript
• node.js

• Installation

• Usage

• License

• Contributing

• Tests

• Questions

To install necessary dependencies, run the following command:

npm install readmegen

Install, run node index.js, and follow prompts in CLI. README.md is saved to '/generated' dir.

This project is licensed under the Apache License 2.0 license.

Pull requests are welcomed, please review guidlines.

To run tests, run the following command:

npm test readmegen

Will test if inquirer prompt input will replace matching item in template file.

If you have any questions about the repo, open an issue or contact Tanner Griffin directly at [email protected].