Add documentation on installing with npm

shutterstock · Sep 12, 2015 · 0c9b175 · 0c9b175
1 parent 9925ea3
commit 0c9b175
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,8 @@
-### [0.0.2] - 2015-09-11
+### [0.1.1] - 2015-09-11
+#### Added
+- Documentation on installing with npm
+
+### [0.1.0] - 2015-09-11
 #### Added
 - Documentation
 - Changelog

diff --git a/README.md b/README.md
@@ -6,12 +6,18 @@
 [ci-img]:  https://travis-ci.org/shutterstock/postcss-copy-assets.svg
 [ci]:      https://travis-ci.org/shutterstock/postcss-copy-assets
 
+## Installation
+```shell
+$ npm install postcss-copy-assets
+```
+
 ## Example
 ### Usage
 ```js
+var copyAssets = require('postcss-copy-assets');
 postcss(
     [
-        require('postcss-copy-assets')({ base: 'dist'})
+        copyAssets({ base: 'dist'})
     ],
     {
         to: 'dist/css/foo.css'
@@ -76,9 +82,10 @@ The base path where the plugin will copy images, fonts, and other assets it find
 This plugin requires the `to` option to be passed to `postcss` itself. This specifies where the transformed CSS will be written to.
 
 ```js
+var copyAssets = require('postcss-copy-assets');
 postcss(
     [
-        require('postcss-copy-assets')({ base: 'base/dir/to/copy/assets'})
+        copyAssets({ base: 'base/dir/to/copy/assets'})
     ],
     {
         to: 'path/to/transformed/file.css'