README.md template

READMETemplateForOSS.md

Readme Template

This is a README.md template for open source software.

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.)

Table of Contents

• Features
• Prerequisites
• Getting Started
• Contributing
• License

Features

• Feature 1
• Feature 2
• Feature n

Prerequisites

• Prereq 1
• Prereq 2
• Prereq n

❗ Note: [If needed]

Getting Started

The easiest way to get started is to clone the repository:

git clone [email protected]:[user]/project-name.git

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.

Changelog

1.0.1 (May 11, 2014)

• Add what was changed
• ...

1.0.0 (May 11, 2014)

• Add what was changed
• ...

Contributing

Pull requests are always welcome. Please open an issue before submitting a pull request.

License

The MIT License (MIT)