ReadmeGenerator walkthru video
Note: I have used this app itself for sample output purposes.
This app helps the user to auto generate a professional looking README.md. It interactively asks the user pertinent questions about the app, such as title, description, installation instructions, usage instructions, license information, how to contribute and collaborate to make the app a better product and collects user e-mail and github username so that any questions can be sent to the author ( user).
You need inquirer package installed for this app to run. So the steps are :
- Clone this repository
- Issue
npm iat your local repository root, so that all dependencies (inquirer package) is installed. - Then launch node index.js and answer all questions properly.
- Your README.md will get auto-generated.
Since this is a command line app, just run 'node index.js'. The app will ask series of questions, once you answer all of them the app will automatically generate a professional looking README.md. The README.md can only be as good as the answers. So spend time to provide proper and well thought out answers to the interactive questions of the app
This project is licensed under the ISC License.
Please use my e-mail to contact me on how to contribute to this project.
There are no automated tests written for this app. However it is easy to launch the app and answer the questions, at the end README.md will get generated.