jorguzman100 / 09_readme_generator

A CLI application that dynamically generates a README.md from a user's input.

Test

Project description text text text text

Badges

Code quality and validation

Repository Status

License

Table of contents

• Test
  • Badges
  • Table of contents
  • The challenge
  • The development process
  • The Output
  • Installation and Usage
  • Credits, tools and other references
  • Contributing
  • Questions

The challenge

Challenge description ...

elements:

• Element
• Element
• Element

The development process

In order to accomplish the challenge, the following steps were taken:

1. Define the purpose, and concept of the application.
2. Define MVPs (Minimum Viable Products) and due dates.
3. Research assets.
4. Define and build the base layout and grid, considering two stages:
   • Mobile-first approach.
   • Responsive design for larger screen sizes.
5. Create functionality.
6. Apply semantic HTML.
7. Asses valid HTML with W3C validator.
8. Benchmark the site with WebsiteGrader.
9. Final review and proper documentation.

The Output

With the described process we were able to create a useful, efficient and responsive application that ...

User stories

1. As a I can , so that
2. As a I can , so that

The application

Video

Installation and Usage

The project was uploaded to GitHub at the following repository: https://github.com/jorguzman100/09_README_Generator

You can access the deployed application with the GitHup Pages link: https://jorguzman100.github.io/09_README_Generator/

To install the project follow these steps:

1. Step
2. Step

Credits, tools and other references

Third Party Assets

Other asset

npm

Contributing

• Pull requests are welcome.
• For major changes, please open an issue first to discuss what you would like to change.
• Please make sure to update tests as appropriate.

Questions

If you have questions or you want to share comments, we will be glad to hear from you. Please contact us at [email protected].