This application allows you to dynamically create a professional ReadMe.md using the command-line.
- As a developer, we all need a good ReadMe to showcase our project. A decent ReadMe can take up too much time, and I'd rather spend that time debugging 🐛 my code. So, this CLI application is created to help you and I be more efficient.
GIVEN a command-line application that accepts user input
WHEN I am prompted for information about my application repository
THEN a high-quality, professional README.md is generated with the title of my project and sections entitled Description, Table of Contents, Installation, Usage, License, Contributing, Tests, and Questions
WHEN I enter my project title
THEN this is displayed as the title of the README
WHEN I enter a description, installation instructions, usage information, contribution guidelines, and test instructions
THEN this information is added to the sections of the README entitled Description, Installation, Usage, Contributing, and Tests
WHEN I choose a license for my application from a list of options
THEN a badge for that license is added near the top of the README and a notice is added to the section of the README entitled License that explains which license the application is covered under
WHEN I enter my GitHub username
THEN this is added to the section of the README entitled Questions, with a link to my GitHub profile
WHEN I enter my email address
THEN this is added to the section of the README entitled Questions, with instructions on how to reach me with additional questions
WHEN I click on the links in the Table of Contents
THEN I am taken to the corresponding section of the README
Clone repo, run npm init, install dependencies, run node
To clone the repo:
git clone
git@github.com:vynguyen205/ReadMe-Generator.git
- JavaScript (React.js and Node.js)
License used for this project - MIT
- For more information on license types, please reference this website for additional licensing information - https: //choosealicense.com/.
To contribute to this application, create a pull request. Here are the steps needed for doing that:
- Fork the repo
- Create a feature branch (git checkout -b NAME-HERE)
- Commit your new feature (git commit -m 'Add some feature')
- Push your branch (git push)
- Create a new Pull Request Following a code review, your feature will be merged.
Answer the questions prompted in the command line. Once you are done, the ReadMe will automatically be generated. Some parts of the ReadMe is left blank intentionally, so that you can manually input your own information in after the important parts of the ReadMe has been generated. Whichever part of the ReadMe that is not necessary to your project, please remove.
Built by Vy Nguyen
- GitHub Username: vynguyen205
- GitHub Email: vynguyen0520@gmail.com