/readmebuilder

README Builder

Primary LanguageJavaScriptMIT LicenseMIT

README Builder - A great README generator

MIT license

When creating an open source project on GitHub, it is important to have a quality README with information about the app--what is the app for, how to use the app, how to install it, how to report issues, and how to make contributions so that other developers are more likely to use and contribute to the success of the project. A command-line application will allow for quick and easy generation of a project README to get started quickly. This will allow a project creator to spend more time working on finishing the project and less time creating a good README.

Table of Contents

Installation

  1. Clone this GitHub repository

    git clone git@github.com:harishnarain/readmebuilder.git
    
  2. Install all dependent npm packages

    npm install --save
    

Usage

Run node index.js and answer the prompts to get a generated README.md in the same working directory.

License

This project uses the MIT license

Contributing

Pull requests are welcome

Screenshots

Walkthrough

Questions

Checkout my GitHub profile

Please feel free to email at: harishnarain@gmail.com