Skip to content
Create a gist now

Instantly share code, notes, and snippets.

README.md template

Synopsis

At the top of the file there should be a short introduction and/ or overview that explains what the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)

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.

Motivation

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

Installation

Provide code examples and explanations of how to get the project.

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.

Contributors

Let people know how they can dive into the project, include important links to things like issue trackers, irc, twitter accounts if applicable.

License

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

@ghost
Unknown commented

Thank you :)

@aloisdg

Thanks !

@BrainCrumbz

Thank you! (...If I remember, you will not receive a notification for this)

@Sovietaced

Thank you!

@carlosloslas

Thanks very much for a great template!

@angajime

Great template, thank you very much!

@Plimsky

Nice ! Thanks :-D

@RayFoss

Would be nice to have some more basic markdown in it.

@ccywch

Thanks a lot!

@mitbal

This is helpful. Thank you

@gkbluestocking

This is an excellent guide. Thank you.

@colkito

great! thanks!

@samkho10

Awesome, thanks!

@KevDoy

This is great. Thank you!

@Herm71

Nice template, thanks!

@Laicure

Thanks! Nice template! <3

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.