If it's not documented, it doesn't exist
You could write the best code in the world, but if no one knows how to install or use it, it's useless.
The Perfect README Answers:
- 1What does this project do?
- 2Why is it useful?
- 3How do I install it?
- 4How do I use it?
Markdown Cheat Sheet
Headers
# Heading 1
## Heading 2
### Heading 3
## Heading 2
### Heading 3
Lists
- Item 1
- Item 2
- Subitem
- Item 2
- Subitem
Emphasis
**Bold**
*Italic*
`Code`
*Italic*
`Code`
Links & Images
[Link Text](url)
Tools for Documentation
Mermaid.js
Diagrams as code
Carbon
Beautiful code screenshots
Badges
shields.io status icons