Skip to content

Commit

Permalink
Update Readme.md
Browse files Browse the repository at this point in the history
Be more explicit: calls go onto jQuery object, not plain element
  • Loading branch information
sabberworm committed Nov 10, 2014
1 parent 11d10d8 commit c8a3ed0
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ But there are some great things about it: it is quite small, does not produce ma
## Usage
Have an empty element ready. Include the js and css files and you’re good to go:

element.starbox({
$(element).starbox({
average: 0.42,
changeable: 'once',
autoUpdateAverage: true,
Expand Down Expand Up @@ -120,4 +120,4 @@ jStarbox is freely distributable under the terms of an MIT-style license.
There is no rounding of the initial average. If you want a nice full-star (or half-star) value, round it yourself first (you know how to do that!).

### Images
The philosophy follows that of the original Starbox which means it uses semi-transparent images under whose it displays bars with the same height and an arbitrary length (representing the rating). These bars are relatively easily stylable using background colors (or even images). The only drawback (I can think of) is that Starboxes don’t work on non-unicolor backgrounds (at least not if you don’t exactly know which part of the background they’re going to land on) and require new images for non-white unicolor backgrounds.
The philosophy follows that of the original Starbox which means it uses semi-transparent images under whose it displays bars with the same height and an arbitrary length (representing the rating). These bars are relatively easily stylable using background colors (or even images). The only drawback (I can think of) is that Starboxes don’t work on non-unicolor backgrounds (at least not if you don’t exactly know which part of the background they’re going to land on) and require new images for non-white unicolor backgrounds.

0 comments on commit c8a3ed0

Please sign in to comment.