The DocuGenius Readme Generator is a powerful and user-friendly command-line application. It serves one simple but essential purpose - to dynamically generate a professional README.md file from a users input. It does this with the help of the Inquirer package, a comprehensive collection of common interactive command line user interfaces.
AS A developer
I WANT to add a table of contents to my README.md that links to specific sections.
SO THAT users can easily navigate the document.
GIVEN a command-line application that accepts user input
WHEN I click on the links in the Table of Contents
THEN I am taken to the corresponding section of the README.
AS A developer
I WANT to add my contact information to the README.md
SO THAT users can reach out to me with any additional questions.
GIVEN a command-line application that accepts user input
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.
AS A developer
I WANT to select a license for my application and display it in my README.md
SO THAT users understand the legal protections and obligations of my application.
GIVEN a command-line application that accepts user input
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.
AS A developer
I WANT to fill sections of my README.md with specific information about my project
SO THAT users can better understand and utilize my application.
GIVEN a command-line application that accepts user input
WHEN I enter a description, installation instructions, usage information, contribution guidelines, questions, and test instructions
THEN this information is added to the sections of the README entitled Description, Installation, Usage, Contributing, and Tests.
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.
