diff --git a/README.md b/README.md index 213a0d2..bf46661 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,26 @@ Css Star Rating is written in scss and fully customizable over variables. Easily compose your own rating component over a rich set of css modifiers for any kind of UI state. + +##Features + +- [x] **Written in scss** +- [x] **Customizable over variables** +- [x] **Different Numbers of stars** +- [x] **Color of stars depend on rating** +- [x] **Display rating over css class** +- [x] **Half stars** +- [x] **Sizes** +- [x] **Star alignments** +- [x] **Static colors** +- [x] **Disabled mode** +- [x] **Star types** +- [x] **Label** +- [x] **Label positions** +- [x] **Animations** +- [x] **Directions** +- [x] **Themes** + ## Install **Get Css Star Rating:** @@ -56,24 +76,7 @@ If you want to use svg as icon type copy the ``` -##Features -- [x] **Written in scss** -- [x] **Customizable over variables** -- [x] **Different Numbers of stars** -- [x] **Color of stars depend on rating** -- [x] **Display rating over css class** -- [x] **Half stars** -- [x] **Sizes** -- [x] **Star alignments** -- [x] **Static colors** -- [x] **Disabled mode** -- [x] **Star types** -- [x] **Label** -- [x] **Label positions** -- [x] **Animations** -- [x] **Directions** -- [x] **Themes** ##Css Modifiers @@ -170,6 +173,7 @@ The height and width of the stars. **color-[COLOR_NAME]**: +Static color of stars. - .color-default - .color-negative - .color-middle @@ -215,7 +219,7 @@ The direction of the stars and label. -**.[ANIMATION_SPEED]**: +**.[ANIMATION_SPEED]**: The duration of the animation in ms. - .immediately - .noticeable @@ -232,7 +236,7 @@ The duration of the animation in ms. -**starType**: starRatingStarTypes (Optional) +**starType**: The type of start resource to use. - .star-icon - .star-svg @@ -243,4 +247,7 @@ The type of start resource to use. ...svg and icon stars... -``` \ No newline at end of file +``` + +## Related projects: +- [Angular Star Rating](https://github.com/BioPhoton/angular-star-rating) \ No newline at end of file