This is RichStone's collection of different types of READMEs. Check out the types folder for more types or let me know about new cool READMEs :)

Example of a seriously detailed README:

this README.md template was originally created by Dan Bader and extend by RichStone

An example project that uses this extensive template is my data collection tool

(let me know if you need any translations of the template.)

Product Name

Short blurb about what your product does.

One to two paragraph statement about your product and what it does.

Installation

OS X & Linux:

npm install my-crazy-module --save

Windows:

edit autoexec.bat

Usage example

A few motivating and useful examples of how your product can be used. Spice this up with code blocks and potentially more screenshots.

For more examples and usage, please refer to the Wiki.

Development setup

Describe how to install all development dependencies and how to run an automated test-suite of some kind. Potentially do this for multiple platforms.

make install
npm test

Release History

• 0.2.1
  • CHANGE: Update docs (module code remains unchanged)
• 0.2.0
  • CHANGE: Remove setDefaultXYZ()
  • ADD: Add init()
• 0.1.1
  • FIX: Crash when calling baz() (Thanks @GenerousContributorName!)
• 0.1.0
  • The first proper release
  • CHANGE: Rename foo() to bar()
• 0.0.1
  • Work in progress

Meta

Your Name – @YourTwitter – YourEmail@example.com

Distributed under the XYZ license. See LICENSE for more information.

https://github.com/yourname/github-link

Contributing

1. Fork it (https://github.com/yourname/yourproject/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request

Future Features Ideas

• Feature One
• Feature Two

Neccessary Refactorings

• refactor this
• refactor that

Use Future Features and Neccessary Refactorings rather sparingly and only as long as collaboration and project size are overseeable.

Code Metrics

Let people know how you worked on this project.

• How did you plan it?
• How much time did it take?
• What was easy, where did you struggle? e.g.: this project