- This is a command-line application which dynamically and efficiently generates a README.md file.
- Build to allow developers to focus on their code as opposed to spending a long time on their README.md file.
- I learnt that automation and efficiency are hugely important as a developer.
-
Type 'npm i' in the command-line.
-
Install npm i [email protected]
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
- link to GitHub repo was not working. Issue solved by taking away the ! symbol.
- Readme file created was being overwritten. Issue solved by directing the created file to a folder.
- 0.1 Created a black readme
- 0.2 Entered Questions into index.js
- 0.3 Added internal links within readme
- 0.4 Added licenses and their respective badges.
- Pull the repo, work on it locally, then push up to be acccepted.
- MIT