From 45b2729422350d0480099c81b04c566c7c8b9175 Mon Sep 17 00:00:00 2001
From: Dominik George <nik@naturalnet.de>
Date: Wed, 1 Aug 2018 23:48:59 +0200
Subject: [PATCH] Add readme.

---
 README.rst | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 README.rst

diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..5c03dec
--- /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.
-- 
GitLab