readme_generator_heeringdesign
v1.0.0
Published
A command-line README generator. It is run in terminal and poses questions to the user, and the responses are formatted into markdown text.
Downloads
1
Maintainers
Readme
Readme Generator
License
Distributed under MIT
Description
The application takes in user input from questions and formats their responses in markdown text.
Installation
Installation command: npm install read_me_generator
(note: this is not currently available, once it is published, it will be, but at this time, it is not. In the meantime, download the source code, and then you will run it the same way).
Run this in terminal: node index.js
Usage
run the isntallation command in the folder of an application you want a read me for. Then type "node index.js" and follow the prompts.
Contributors
Matthew Heering
Contact
Below are two ways you can contact contributors of the project or submit bugs:
-Github Username: mcheering
-Email: [email protected]