From 742f45223232a824cdd077d5aae1a4bb5c2aa26b Mon Sep 17 00:00:00 2001 From: Cole Bemis Date: Fri, 18 May 2018 16:59:19 -0700 Subject: [PATCH] docs: Update README.md --- README.md | 36 ++++++++++++++++++++---------------- 1 file changed, 20 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 7c4e995..4ce992c 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Feather is a collection of simply beautiful open source icons. Each icon is desi https://feathericons.com -```sh +```shell npm install feather-icons ``` @@ -77,7 +77,7 @@ The following are additional ways you can use Feather. Install with [npm](https://docs.npmjs.com/getting-started/what-is-npm). -``` +```shell npm install feather-icons --save ``` @@ -85,13 +85,15 @@ Or just copy [`feather.js`](https://unpkg.com/feather-icons/dist/feather.js) or #### 2. Include -Include `feather.js` or `feather.min.js` with a ` ``` -Or load the script from a CDN provider. +> **Note:** `feather.js` and `feather.min.js` are located in the `dist` directory of the npm package. + +Or load the script from a CDN provider: ```html @@ -103,7 +105,7 @@ After including the script, `feather` will be available as a global variable. #### 3. Use -To use an icon on your page, add a `data-feather` attribute with the icon name to an element. +To use an icon on your page, add a `data-feather` attribute with the icon name to an element: ```html @@ -113,7 +115,7 @@ See the complete list of icons at [feathericons.com](https://feathericons.com). #### 4. Replace -Call the `feather.replace()` method. +Call the `feather.replace()` method: ```html