The secret sauce to creating a growing and preposterous project is a great README documentation. It invites new contributors and makes developers 55% more productive.
— Source: Github Octoverse
In this article, I will share with you the secrets to creating a README that stands out. Let’s begin!
Choosing a name is always a challenge, but you know how crucial it is. Your label will dictate your users’ first impression and set you apart from the competition.
While there is no exact formula for coming up with names, there’s a wide variety of techniques that you can try out:
Are you making an HTTP CLI? Then call your project
http-cli; it’s as simple as that!
- Very quick to come up with.
- Very simple.
- It’s not easy to forget.
- It’s highly likely that the name will already be taken.
Pick a word from the dictionary, and preferably one that makes sense to your product. Examples: Target, Gap, Staples.
- Very easy to create.
- It’s also highly likely that the name will already be taken.
Your label could be an abbreviation of a longer name. Examples: Mozilla Developer Network → MDN.
- Very memorable!
- Can be hard to come up with.
You can use your imagination to create a brand new word that’s not in the dictionary! Examples: Xerox, Verizon.
- It sticks!
- Can be hard to spell or pronounce.
The first thing that a person will see when they open your repository is the cover image. This is your chance to grab that person’s attention, and to get them to be interested in your product!
But how can you make a cover image? Here is a list of open-source tools that you can use:
This is arguably the most essential section in your project. This is where you show people what your project is about, and why they should use it.
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. I can assure you that it will increase the reputation of your Github repository!