Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Daryl Lau committed Mar 8, 2014
1 parent d175c00 commit 2c77d01
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,21 @@ gif:
---
####Examples showing five stars
----
Declaration:

`var IconRating = require('react-icon-rating')`


Font-Awesome 4:

`<IconRating toggledClassName="fa fa-star" untoggledClassName="fa fa-star-o"/>`


Glyphicons:

`<IconRating toggledClassName="glyphicon glyphicon-star" untoggledClassName="glyphicon glyphicon-star-empty"/>`


Others:
The component assumes the icon is contained inside an <i> tag, fill the class names in accordingly.
Do note, that you can pass additional classes to the IconRating for styling purposes.
Expand Down

0 comments on commit 2c77d01

Please sign in to comment.