update and format README

This commit is contained in:
Ian J. Miller 2017-11-06 09:56:49 -06:00
parent 24b8d9b30e
commit 2619393020

View File

@ -1,11 +1,13 @@
#Feather Icons React
# Feather Icons React
[![npm](https://img.shields.io/npm/v/feather-icons-react.svg)](https://www.npmjs.com/package/feather-icons-react)
`npm install --save feather-icons-react`
This package lets you use Feather Icons as a React Component.
Feather Icons is an svg font library by Cole Bemis (https://feathericons.com/).
[Feather Icons](https://feathericons.com/) is an svg font library by Cole Bemis.
Example usage:
### Example usage:
```
import FeatherIcon from 'feather-icons-react';
<FeatherIcon icon="close" />
@ -19,4 +21,4 @@ Size can be passed as either string or number.
e.g.: `<FeatherIcon icon="copy" size="24" />` or `<... size={24} />`
The icon names can all be referenced at: https://feathericons.com/
The icon names can all be referenced at: [feathericons.com](https://feathericons.com/)