Awesome Lists

readme-best-practices

by jehna

pushed about 3 years ago

Best practices for writing a README for your open source project

AI summary

README template

Provides a template and guidance for writing an effective README file for open-source projects

stars
885
forks
843
watching
15
awesome list
1
View on GitHub

Embed the badge

Show how many awesome lists link to your project. The count updates automatically.

Awesome Lists badge
Markdown
[![Awesome Lists Badge](https://awesome.facts.dev/shield/jehna/readme-best-practices/links.svg)](https://awesome.facts.dev/awesome/jehna/readme-best-practices)
HTML
<a href="https://awesome.facts.dev/awesome/jehna/readme-best-practices"><img src="https://awesome.facts.dev/shield/jehna/readme-best-practices/links.svg" alt="Awesome Lists Badge" /></a>
Image URL
https://awesome.facts.dev/shield/jehna/readme-best-practices/links.svg

Add a GitHub project

Missing a project or an awesome list? Paste its GitHub URL and we fetch it right away.