Node.js console application to build readme based on user inputs
Readme builder is an application that helps quickly build the readme files
To install dependencies, run the following command:
npm install
Third party libraries
- ora
- boxen
- Axios
- inquirer
- how to run: run the following command
node index - When the app asks for inputs, for some questions the app is going to open the default editor to get your input
- default for windows in notepad and for mac/linux is vim
- when the editor open up make sure you enter your input, save and close the editor. Unless you close your editor the app will not proceed.
- Note unsaved file in the opened editor is as good as no input. So please Save and close the editor.
- on windows if notepad is your defualt editor you can use shortcuts like CTRL+S
- on mac/linux in order to save and quit vim use
:wq
This project is licensed under the MIT license
To contribute to this project issue pull requests
If you have any questions you can contact me direct at bhagat.abhijeet@gmail.com.
Reach out to me at GitHub : bhagatabhijeet
