forked from dbader/readme-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
66 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 1,66 @@ | ||
| # readme-example | ||
| README.md example for your open-source project | ||
| # 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: | ||
|
|
||
| ```sh | ||
| 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. | ||
|
|
||
| ```sh | ||
| 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](https://twitter.com/dbader_org) – [email protected] | ||
|
|
||
| Distributed under the XYZ license. See ``LICENSE`` for more information. | ||
|
|
||
| [https://github.com/yourname/github-link](https://github.com/dbader/) | ||
|
|
||
| [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 |