1. Center Your Elements
Bring elements like your logo or headings to the center to make them pop.
Example:
<div align="center">
<img src="your-logo-url" alt="Logo" width="320" />
</div>
2. Responsive Logo
Use <picture>
and <source>
to make your logo responsive and cater to different color schemes.
Example:
<picture>
<source media="(prefers-color-scheme: dark)" srcset="dark-image-url">
<img src="light-image-url" alt="Logo" />
</picture>
3. Add Badges
Use badges to highlight important info like license, stars, docs, and more.
Visit shields.io and choose from their collection.
Examples:
[![MIT License](https://img.shields.io/github/license/tutim-io/tutim)](https://github.com/tutim-io/tutim/blob/main/LICENSE)
[![Number of GitHub stars](https://img.shields.io/github/stars/tutim-io/tutim?logo=github)](https://github.com/tutim-io/tutim/stargazers)
[![Discord is Live](https://img.shields.io/badge/Discord-Live-green?logo=discord&logoColor=%23fff)](https://discord.tutim.io)
[![Docs are updated](https://img.shields.io/badge/docs-updated-green?color=blue)](https://docs.tutim.io)
[![Product Hunt](https://img.shields.io/badge/Product%20Hunt-Launch%20soon-orange?logo=producthunt&logoColor=%23fff)](https://www.producthunt.com/@leetwito)
4. Demo GIF
Include a demo GIF to give users a quick preview of your project.
Extra: You can just drag-and-drop your GIF file into GitHub's editor.
5. Feature List
List your project's features in bullet points to make it easy for users to skim through.
Example:
### β¨ Features
- π Headless
- π
Rich form
- π Performant
6. Getting Started
Provide a quick start guide with clear instructions and code snippets.
Make sure to visualize the output, outline requirements, and keep it simple.
7. Code Examples
Give clear examples of how to use your project, with detailed code snippets.
8. Community and Support
Include links to your community, like Discord, Twitter, and contribution guidelines.
Example:
### π€΅ Need Help?
Join our [Discord server](https://discord.tutim.io) or [Open an issue](https://github.com/tutim-io/tutim/issues/new/choose)
### π Links
- [Home page](https://tutim.io)
- [Twitter](https://twitter.com/Tutim_io)
9. Star History
Display your repo's growth with a Star History chart.
Example:
## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=tutim-io/tutim&type=Date)](https://tutim.io/developers)
10. Showcase Contributors
Acknowledge and celebrate the people who've contributed to your project by displaying their avatars.
Example:
### πͺ By the community, for the community
![](https://contrib.rocks/image?repo=your-username/your-repo)
Powered by [your-project-name](https://your-project-url)
Top comments (0)