Skip to content

Instantly share code, notes, and snippets.

@johnro
johnro / README.md
Last active May 5, 2017 06:31 — forked from jxson/README.md
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.)

Motivation

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

Prerequisites and setup