Merge pull request #34 from atugushev/master

[django-pagination.git] / README.rst

diff --git a/README.rst b/README.rst
new file mode 100644 (file)
index 0000000..190dc82
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,48 @@
+========================
+Linaro Django Pagination
+========================
+
+.. image:: https://travis-ci.org/zyga/django-pagination.svg?branch=master
+    :target: https://travis-ci.org/zyga/django-pagination
+
+.. image:: https://coveralls.io/repos/zyga/django-pagination/badge.svg?branch=master&service=github
+    :target: https://coveralls.io/github/zyga/django-pagination?branch=master
+
+
+About the fork
+--------------
+
+This project is a fork of apparently dead "django-pagination" project
+originally written by 'Eric Florenzano'. It is maintained by the Linaro
+Validation/Infrastructure team. Latest releases can be found on launchpad and
+pypi.
+ 
+We are in the process of deciding how to properly host and manage the project.
+Feel free to hop to #linaro on irc.freenode.net and ask either 'zyga' or
+'mwhudson' about this.
+
+
+About top-level package name change
+-----------------------------------
+The top level package name was changed from `pagination` to
+`linaro-django-pagination`. I did this to ensure that existing users of the
+original package could easily transition, on their own terms. Since both
+packages are co-installable you are free to check things out and see if the new
+pagination code works well for you or not.
+
+Also, since the implementation of the actual tags was rewritten I would not
+feel entirely confident that the new package is a drop-in replacement.
+
+
+Contributors
+------------
+
+We would like to welcome any and all contributors. Please use the pull request
+feature on github.
+
+
+How to use linaro-django-pagination
+-----------------------------------
+
+See our official documentation for more details.
+http://packages.python.org/linaro-django-pagination/