This application utilizes the inquirer NPM package to capture user input through the command line interface and generate a personalized README file.
Clone the repository:
git clone git@github.com:t-starkw/me-read.git
Install the required dependencies:
npm install
Run the project in your local browser:
node index.js
To generate your own README for your next project or application, simply run the command the node index.js
in your preferred terminal and answer the prompts that follow.
Need extra help? Watch this short Demo Video
View the sample README here
Tessa Starkweather – LinkedIn – tess.starkweather@gmail.com
View my profile – GitHub
Distributed under the MIT license. See LICENSE
for more information.
- Fork it (https://github.com/t-starkw/me-read/fork)
- Create your feature branch (
git checkout -b feature/fooBar
) - Commit your changes (
git commit -am 'Add some fooBar'
) - Push to the branch (
git push origin feature/fooBar
) - Create a new Pull Request