Markdowns & README Cheatsheets

This repository contains examples for creating better README files using Markdown in the best way possible.

Table of Contents

• Flowcharts

• Pie Charts

• Sequence Diagrams

Main Contents

• Contributing

• License

• Additional Resources

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/my-contribution)
3. Commit your Changes (git commit -m 'Add Amazing Contribution comment')
4. Push to the Branch (git push origin feature/my-contribution)
5. Open a Pull Request

License

Distributed under the GNU GENERAL PUBLIC LICENSE

Additional Resources

• Mermaid Diagram and Flowchart

• Best-README-Template

• VS Code Extension:

  Key	Value
  Id	bierner.markdown-mermaid
  Name	Markdown Preview Mermaid Support
  Description	Adds Mermaid diagram and flowchart support to VS Code's builtin markdown preview
  Version	1.23.0
  Publisher	Matt Bierner
  VS Marketplace Link	https://marketplace.visualstudio.com/items?itemName=bierner.markdown-mermaid