diff --git a/README.rst b/README.rst new file mode 100644 index 0000000000000000000000000000000000000000..5c03deca501409c948f22ca9c1de0707950008ab --- /dev/null +++ b/README.rst @@ -0,0 +1,25 @@ +Django stars widget +=================== + +Description +----------- + +This is a simple widget rendering so-called rating stars as input for an +integer field. It is based solely on CSS 3, as laid out by `Martin Ivanov +<http://experiments.wemakesites.net/css3-rating-stars-with-selection.html>`_. + +Usage +----- + +Just add the Stars widget to any IntegerField in a Django form. + +.. code:: python + + from django import forms + from django_starfield import Stars + + class StarsExampleForm(forms.Form): + rating = forms.IntegerField(widget=Stars()) + +You can change the number of stars by passing the stars argument to the +Stars widget.