├── README.md
└── package.json


/README.md:
--------------------------------------------------------------------------------
 1 | ## npm-badge
 2 | 
 3 | > How to add badges to your GitHub readme
 4 | 
 5 | ## Badges
 6 | 
 7 | ### Default
 8 | 
 9 | [![NPM](https://nodei.co/npm/npm-badge.png)](https://npmjs.org/package/npm-badge)
10 | 
11 | ##### Usage
12 | 
13 | Copy this snippet to your README files:
14 | 
15 | ```
16 | [![NPM](https://nodei.co/npm/<package>.png)](https://npmjs.org/package/<package>)
17 | ```
18 | 
19 | _Note: Your package must be published on [npmjs.org](https://npmjs.org/)._
20 | 
21 | ### Compact
22 | 
23 | [![NPM](https://nodei.co/npm/npm-badge.png?compact=true)](https://npmjs.org/package/npm-badge)
24 | 
25 | Append `?compact=true`
26 | 
27 | ```
28 | [![NPM](https://nodei.co/npm/<package>.png?compact=true)](https://npmjs.org/package/<package>)
29 | ```
30 | 
31 | ### Mini
32 | 
33 | [![NPM](https://nodei.co/npm/npm-badge.png?mini=true)](https://npmjs.org/package/npm-badge)
34 | 
35 | Append `?mini=true`
36 | 
37 | 
38 | ```
39 | [![NPM](https://nodei.co/npm/<package>.png?mini=true)](https://npmjs.org/package/<package>)
40 | ```
41 | 
42 | ## Credits
43 | Thanks to [rvagg](https://github.com/rvagg) for creating and hosting https://nodei.co/.
44 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "npm-badge",
 3 |   "version": "1.0.0",
 4 |   "description": "Add badges to your GitHub readme",
 5 |   "main": "README.md",
 6 |   "repository": {
 7 |     "type": "git",
 8 |     "url": "http://github.com/erming/npm-badge"
 9 |   },
10 |   "keywords": [
11 |     "npm",
12 |     "badges",
13 |     "readme",
14 |     "github",
15 |     "markdown"
16 |   ],
17 |   "author": "Mattias Erming",
18 |   "license": "MIT"
19 | }
20 | 


--------------------------------------------------------------------------------