Merge branch 'development'

[django-tables2.git] / README.rst

diff --git a/README.rst b/README.rst
index 171ecfd2db50f4f7700480ef49a37dc9f3b55403..79c3960d4097a8713aa64b3c234cb484de73d587 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,14 +1,44 @@
-===============================================
-django-tables - An app for creating HTML tables
-===============================================
+================================================
+django-tables2 - An app for creating HTML tables
+================================================
 
-django-tables simplifies the task of turning sets of datainto HTML tables. It
+.. note::
+
+    Prior to v0.6.0 this package was a fork of miracle2k's and both were known
+    as *django-tables*. This caused some problems (e.g. ambiguity and inability
+    to put this library on PyPI) so as of v0.6.0 this package is known as
+    *django-tables2*.
+
+django-tables2 simplifies the task of turning sets of data into HTML tables. It
 has native support for pagination and sorting. It does for HTML tables what
 ``django.forms`` does for HTML forms.
 
-Documentation_ is available on http://readthedocs.org
+Creating a table is as simple as::
+
+    import django_tables2 as tables
+
+    class SimpleTable(tables.Table):
+        class Meta:
+            model = Simple
+
+This would then be used in a view::
+
+    def simple_list(request):
+        queryset = Simple.objects.all()
+        table = SimpleTable(queryset)
+        return render_to_response("simple_list.html", {"table": table},
+                                  context_instance=RequestContext(request))
+
+And finally in the template::
+
+    {% load django_tables2 %}
+    {% render_table table %}
+
+
+This example shows one of the simplest cases, but django-tables2 can do a lot
+more! Check out the `documentation`__ for more details.
 
-.. _Documentation: http://readthedocs.org/docs/django-tables/en/latest/
+.. __: http://readthedocs.org/docs/django-tables/en/latest/
 
 
 Building the documentation