Take Your Github Repository To The Next Level

Having a good README can make the difference between a 0-star and a Unicorn Github Project! I hope that this article will help you be one of the unicorns!

1. Beatiful Cover Image

Most popular Github projects have a fancy cover image, whether it's a logo, a quote, or even a video of the product!

For inspiration, see anfederico/Clairvoyant.

2. Convincing Description

This is arguably the most essential section in your project's README. This is where you show people what your project is about, and why it is better than its competitors.

For inspiration, see ai/size-limit.

3. Use Badges

Did you notice those small image links on popular Github projects? They are called badges, and they convey metadata about the project, such as if all tests are passing or not.

Use Shields to add some to your project's README. I can assure you that it will increase the reputation of your Github repository!

For inspiration, see aimeos/aimeos-typo3.

4. Add Visuals

It is a very good idea to add screenshots or videos for a more sophisticated README. It will make your users' experiences much smoother, because they can visually see how they should use your product!

For inspiration, see ajeetdsouza/zoxide.

5. Easy Setup

You should list the specific steps to install your product, because not all of your users will be experts.

For inspiration, see alichtman/shallow-backup.

6. Clear Usage

Always use examples of how your product should be used, and show the expected out if you can.

For inspiration, see alichtman/stronghold.

7. Kind Support

People will eventually need help. You should show them where they can go for that, whether it's an issue tracker, a chat room, or an email address.

For inspiration, see amitmerchant1990/electron-markdownify.

8. Future Roadmap

This is where you should place your plans for the future. Be ambitious, but not too much! You should also be realistic, and to explain why you're taking the steps that you are taking.

9. Use Templates

You don't have to reinvent the wheel.

You can get all of the above, and more, if you use a template.

Here is a list of Github project README templates:

• Best-README-Template: An awesome README template to jumpstart your projects!
• readme-template: scroll Modelos readme para qualquer pessoa copiar e usar em seu GitHub.

Those were 9 tips to point you towards building a better Github project. You should also be asking yourself questions about your repository, like: "What is it", "Why should I make it", etc... If you can answer them, then I can assure you that you're on the right path!

If you found this guide useful, itd be really helpful if you followed me on Twitter for daily webdev updates!

.ltag__user__id__833086 .follow-action-button { background-color: #FF0000 !important; color: #ffffff !important; border-color: #FF0000 !important; }

EludaFollow

I am simply a web development !