writeme-readme
Description
A command-line interface program that generates a markdown formatted README with the users responses to questions.
Table of Contents
Installation
- Download the files (you can clone on github)
- in terminal, run "npm i" to install modules required.
Usage
- Open the folder in terminal.
- Run "node index.js"
- Answer the questions as they come up. You can choose which sections you'd like to add to the README, and the program will ask the relevant questions.
- The generator will create a folder in "output", named with your project title. The README will be written into there.
- There will also be a JSON file containing the data. That can be ignored, it's for future plans of being able to edit the README after its been generated.
Licence
Credits
MDN Web docs has helped me lots in learning to use async functions. @midnightcodr's gist explaining how to use await with inquirer helped a huge amount too.
Badges
Features
- CLI that prompts user for information about their project
- Generates a markdown string containing that info, that gets written to the README file
- Gives options as to which sections are included in the README
- Renders links in the Table of Contents
- Renders licence badge, and other profile, repo and language badges
Contributions
Feel free to fork the project :)
Tests
No tests have been written at this time
Questions
Github profile: poisoned-eden
Feel free to drop me an email, contact me through github, or any other method I have shared on my developer profile.