Skip to content

Instantly share code, notes, and snippets.

View AashitaK's full-sized avatar

Aashita Kesarwani AashitaK

View GitHub Profile
AashitaK /
Created June 19, 2017 14:11 — forked from jxson/ template


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.