Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
A Beginners Guide to writing a Kickass README 

Project title

A little info about your project and/ or overview that explains what the project is about.

Motivation

A short description of the motivation behind the creation and maintenance of the project. This should explain why the project exists.

Build status

Build status of continus integration i.e. travis, appveyor etc. Ex. -

Build Status Windows Build Status

Code style

If you're using any code style like xo, standard etc. That will help others while contributing to your project. Ex. -

js-standard-style

Screenshots

Include logo/demo screenshot etc.

Tech/framework used

Ex. -

Built with

Features

What makes your project stand out?

Code Example

Show what the library does as concisely as possible, developers should be able to figure out how your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.

Installation

Provide step by step series of examples and explanations about how to get a development env running.

API Reference

Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.

Tests

Describe and show how to run the tests with code examples.

How to use?

If people like your project they’ll want to learn how they can use it. To do so include step by step guide to use your project.

Contribute

Let people know how they can contribute into your project. A contributing guideline will be a big plus.

Credits

Give proper credits. This could be a link to any repo which inspired you to build this project, any blogposts or links to people who contrbuted in this project.

Anything else that seems useful

License

A short snippet describing the license (MIT, Apache etc)

MIT © Yourname

@ghost

This comment has been minimized.

Copy link

ghost commented May 22, 2018

Awesome!

@aschwark

This comment has been minimized.

Copy link

aschwark commented May 28, 2018

This is some great information - especially for people new to github and remote collaboration. Thanks for the post!

@toshihidetagami

This comment has been minimized.

Copy link

toshihidetagami commented Jul 3, 2018

Really useful! Thanks!

@kssjmpv1

This comment has been minimized.

Copy link

kssjmpv1 commented Jan 29, 2020

Awesome bro. Imma follow this from now on.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.