About README in project

To be in sight  - putting up a nice-looking and helpful README file.

1. What the purpose of the project is
2. How to install it
3. Example usage
4. How to set up the dev environment
5. How to ship a change
6. Change log
7. License and author info

Example

Product Name

Short blurb about what your product does. [![NPM Version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Downloads Stats][npm-downloads]][npm-url] 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.

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 [npm-image]: https://img.shields.io/npm/v/datadog-metrics.svg?style=flat-square [npm-url]: https://npmjs.org/package/datadog-metrics [npm-downloads]: https://img.shields.io/npm/dm/datadog-metrics.svg?style=flat-square [travis-image]: https://img.shields.io/travis/dbader/node-datadog-metrics/master.svg?style=flat-square [travis-url]: https://travis-ci.org/dbader/node-datadog-metrics

view raw 01-readme.md hosted with ❤ by GitHub

https://medium.com/