Commits

Simon Law committed 43ac0eb

Convert docs to reStructuredText and include them in the sdist.

  • Participants
  • Parent commits d0d6890

Comments (0)

Files changed (6)

+Copyright (c) 2010 Dumbwaiter Design
+
+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.

LICENSE.markdown

-Copyright (c) 2010 Dumbwaiter Design
-
-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.
+include LICENSE
+include README.rst

README.markdown

-django-bcrypt
-=============
-
-[You should be using bcrypt](http://codahale.com/how-to-safely-store-a-password/).
-
-django-bcrypt makes it easy to use bcrypt to hash passwords with Django.
-
-Installation and Usage
-----------------------
-
-Install the package with [pip][] and [Mercurial][] or [git][]:
-
-    pip install -e
-    hg+http://bitbucket.org/dwaiter/django-bcrypt#egg=django-bcrypt
-    
-    # or ...
-    
-    pip install -e git://github.com/dwaiter/django-bcrypt.git#egg=django-bcrypt
-
-[pip]: http://pip.openplans.org/
-[Mercurial]: http://hg-scm.org/
-[git]: http://git-scm.com/
-
-Add `django_bcrypt` to your `INSTALLED_APPS`.
-
-That's it.
-
-Any new passwords set will be hashed with bcrypt.  Old passwords will still
-work fine.
-
-Configuration
--------------
-
-You can set `BCRYPT_ROUNDS` in `settings.py` to change the number of rounds
-django-bcrypt uses.  The default is `12`.
-
-You can change the number of rounds without breaking already-hashed passwords.
-New passwords will use the new number of rounds, and old ones will use the old
-number.
-
-Acknowledgements
-----------------
-
-This is pretty much a packaged-up version of
-[this blog post](http://kfalck.net/2010/12/27/blogi-linodessa-ja-bcrypt-kaytossa)
-for easier use.  It also depends on the
-[py-bcrypt](http://www.mindrot.org/projects/py-bcrypt/) library.
+django-bcrypt
+=============
+
+`You should be using bcrypt`_.
+
+.. _You should be using bcrypt:
+   http://codahale.com/how-to-safely-store-a-password/
+
+django-bcrypt makes it easy to use bcrypt to hash passwords with Django.
+
+
+Installation and Usage
+----------------------
+
+Install the package with `pip`_ and `Mercurial`_ or `git`_::
+
+    pip install -e hg+http://bitbucket.org/dwaiter/django-bcrypt#egg=django-bcrypt
+    
+    # or ...
+    
+    pip install -e git://github.com/dwaiter/django-bcrypt.git#egg=django-bcrypt
+
+.. _pip: http://pip.openplans.org/
+.. _Mercurial: http://hg-scm.org/
+.. _git: http://git-scm.com/
+
+Add ``django_bcrypt`` to your ``INSTALLED_APPS``.
+
+That's it.
+
+Any new passwords set will be hashed with bcrypt.  Old passwords will still
+work fine.
+
+
+Configuration
+-------------
+
+You can set ``BCRYPT_ROUNDS`` in ``settings.py`` to change the number of
+rounds django-bcrypt uses.  The default is ``12``.
+
+You can change the number of rounds without breaking already-hashed passwords.
+New passwords will use the new number of rounds, and old ones will use the old
+number.
+
+
+Acknowledgements
+----------------
+
+This is pretty much a packaged-up version of `this blog post`_ for easier
+use.
+
+It also depends on the `py-bcrypt`_ library.
+
+.. _this blog post:
+   http://kfalck.net/2010/12/27/blogi-linodessa-ja-bcrypt-kaytossa
+
+.. _py-bcrypt:
+   http://www.mindrot.org/projects/py-bcrypt/
 
 install_requires = ['py-bcrypt']
 
-README_PATH = os.path.join(os.path.abspath(os.path.dirname(__file__)), 'README.markdown')
+README_PATH = os.path.join(os.path.abspath(os.path.dirname(__file__)),
+                           'README.rst')
 
 description = 'Make Django use bcrypt for hashing passwords.'
-long_description = description
+long_description = open(README_PATH, 'r').read()
 
 setup(
     name='django-bcrypt',