add usage example to README

georgewhewell · Jan 19, 2015 · dc249c8 · dc249c8
1 parent 976c0ba
commit dc249c8
Showing 1 changed file with 30 additions and 1 deletion.
diff --git a/README.rst b/README.rst
@@ -17,8 +17,37 @@ Use Google Sheets as context variables in Django templates
      :target: https://requires.io/github/georgewhewell/django-sheets/requirements/?branch=master
      :alt: Requirements Status
 
+Usage
+_____________
+
+In your template::
+
+    {% load sheets %}
+    {% csv "1uPsdcGUnUsf3d2xGHRGUUb7_k5IQPtBvfQY61u8Z8wE" as csv_data %}
+    <table>
+    {% for row in csv_data %}
+        <tr>
+        {% for cell in row %}
+            <td>{{ cell }}</td>
+        {% endfor %}
+        </td>
+    </table>
+    {% endfor %}
+
+View the output, you should see
+
+=================================  =======================  ===============  =======================
+Origin (English)                   Name (English)           Origin (Native)  Name (Native)
+Australia                          Nicole Kidman            Australia        Nicole Kidman
+Austria                            Johann Strauss           Österreich       Johann Strauß
+Belgium (Flemish)                  Rene Magritte            België           René Magritte
+Belgium (French)                   Rene Magritte            Belgique         René Magritte
+Belgium (German)                   Rene Magritte            Belgien          René Magritte
+=================================  =======================  ===============  =======================
+
+
 
 Documentation
 -------------
 
-Documentation is available at https://django-sheets.readthedocs.org.
+Documentation is available at https://django-sheets.readthedocs.org.