Merge pull request #8 from novafloss/update-readme

Update README.rst + Add License

Reviewed by @aRkadeFR.

Author: wo0dyn

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 PeopleDoc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.rst

@@ -1,39 +1,51 @@
+================
 django-chunkator
 ================
 
 
-Chunk large querysetsinto small chunks, and iterate over them without killing
+Chunk large QuerySets into small chunks, and iterate over them without killing
 your RAM.
 
 .. image:: https://travis-ci.org/novafloss/django-chunkator.svg
 
-Usage::
+Usage
+=====
+
+.. code:: python
 
     from chunkator import chunkator
     for item in chunkator(LargeModel.objects.all(), 200):
         do_something(item)
 
 This tool is intended to work on Django querysets.
-Your model **must** define a pk field (this is done by default, but sometimes
-it can be overridden) and this pk has to be unique. ``django-chunkator`` has
-been tested with Postgresql and SQLite, using regular PKs and UUIDs as primary
-keys.
 
-You can also use ``values()``::
+Your model **must** define a ``pk`` field (this is done by default, but
+sometimes it can be overridden) and this pk has to be unique. ``django-
+chunkator`` has been tested with PostgreSQL and SQLite, using regular PKs and
+UUIDs as primary keys.
+
+You can also use ``values()``:
+
+.. code:: python
 
     from chunkator import chunkator
     for item in chunkator(LargeModel.objects.values('pk', 'name'), 200):
         do_something(item)
 
 .. important::
 
-    If you're using ``values`` you **have** to add at least your "pk" field to
-    the values, otherwise, the chunkator will throw a `MissingPkFieldException`.
-
-----
+    If you're using ``values()`` you **have** to add at least your "pk" field
+    to the values, otherwise, the chunkator will throw a
+    ``MissingPkFieldException``.
 
 .. warning::
 
     This will not **accelerate** your process. Instead of having one BIG query,
     you'll have several small queries. This will save your RAM instead, because
     you'll not load a huge queryset result before looping on it.
+
+
+License
+=======
+
+MIT License.