Kelvin Wong avatar Kelvin Wong committed 21dc4fb

Doc edits linking

Comments (0)

Files changed (1)

 
 .. warning::
 
-   The encoded hash format has changed. This change is backwards
-   incompatible. Please read the notice in the Caveat section.
+   The encoded hash format has changed in version 0.2.0. This change is
+   backwards incompatible. Please read the notice in the Caveat section.
 
 .. warning::
 
 Using source tarballs
 ---------------------
 
-1. Download the source tarball for Django-Scrypt from Pypi
+- Download the source tarball for Django-Scrypt from Pypi
 
    http://pypi.python.org/pypi/django-scrypt/
 
-2. Decompress it and make it your working directory::
+- Decompress it and make it your working directory::
 
    $ tar zxvf django-scrypt-0.2.0.tar.gz
    $ cd django-scrypt-0.2.0
 
-3. Install it into your site-packages (if you install to the system's site
-packages you will probably need to be root or to use ``sudo``)
+- Install it into your site-packages (if you install to the system's site
+packages you will probably need to be root or you will probably need to use
+``sudo``)
 
    ``$ python setup.py install``
 
-4. Test your installation
+- Test your installation
 
    ``$ python setup.py test``
 
 Using Pip and Pypi
 ------------------
 
-1. Use the ``pip`` command to install from Pypi
+If you are installing to the system-wide site-packages then you will probably
+need to be root or you will probably need to use ``sudo``.
+
+- Use the ``pip`` command to install from Pypi
 
    ``$ pip install django-scrypt``
 
-If you are installing to the system-wide site-packages then you will probably need to be root or to use ``sudo``.
-
 Basic Usage
 ===========
 
    This software depends on ``py-scrypt`` version 0.5.5 to reveal
    the Scrypt hashing function. Unfortunately, ``py-scrypt`` contains a bug
    that can result in incorrect hashing when run on 64-bit Linux systems. View
-   the ``py-scrypt`` issue tracker for the latest information on this issue.
+   the ``py-scrypt`` issue tracker for the latest information on this issue. [#]_
+
+.. [#] `Issue 6 <https://bitbucket.org/mhallin/py-scrypt/issue/6/hash-dies-with-sigfpe-when-passing-r-or-p>`_
 
 To use Scrypt as your default password storage algorithm in Django 1.4,
 install it and make the following changes. In your Django 1.4 application
   256
   >>>
 
-More Stuff?
-===========
-
-There is a bit more to the software, but you will have to read the source to
-figure it out. :)
-
 Bugs! Help!!
 ============
 
 
 http://www.kelvinwong.ca/coders
 
-Thanks to Dr Colin Percival for his original Scrypt software,
-also to Magnus Hallin for the py-scrypt Python module.
+Thanks to Dr Colin Percival for his original Scrypt software [#],
+also to Magnus Hallin for the py-scrypt Python module [#].
+
+.. [#] http://www.tarsnap.com/scrypt.html
+.. [#] http://pypi.python.org/pypi/scrypt/
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.