Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
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.)

@ayush3899
Copy link

ayush3899 commented Mar 5, 2018

thanks!!

@Sujay-Muramalla
Copy link

Sujay-Muramalla commented Mar 25, 2018

Thanks a lot!

@jonasespelita
Copy link

jonasespelita commented Apr 18, 2018

Salamat po!

@10007327
Copy link

10007327 commented May 15, 2018

hi

@Clucier17
Copy link

Clucier17 commented Sep 27, 2018

I still don't know how this?

@thibaultferrier
Copy link

thibaultferrier commented Oct 5, 2018

thank you!

@gamejuel87
Copy link

gamejuel87 commented Feb 14, 2019

Thank you for sharing !

@dicksondurosakin
Copy link

dicksondurosakin commented Sep 30, 2022

Thanks for sharing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment