MAKS-IT/feather-icons-ts-react
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
Ian J Miller 2018-03-05 18:22:44 -06:00
parent 5b1eadba59
commit bc1260d8ed
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -4,8 +4,8 @@
`npm install --save feather-icons-react` `npm install --save feather-icons-react`
This package lets you use Feather Icons as a React Component. This package lets you use [Feather Icons](https://feathericons.com/) as a React Component.
[Feather Icons](https://feathericons.com/) is an svg font library by Cole Bemis. Feather Icons is an svg font library by Cole Bemis.
### Example usage: ### Example usage:
``` ```
@ -14,11 +14,16 @@ import FeatherIcon from 'feather-icons-react';
``` ```
Setting a size: **Setting a size:**
Size can be passed as either string or number. Size can be passed as either string or number.
e.g.: `<FeatherIcon icon="copy" size="24" />` or `<... size={24} />` e.g.: `<FeatherIcon icon="copy" size="24" />` or `<... size={24} />`
Sizes can always be easily overridden by CSS.
The icon names can all be referenced at: [feathericons.com](https://feathericons.com/)
The icons are all square.
The full list of icon names can be referenced at: [feathericons.com](https://feathericons.com/)