documentation updates

=====================
* CryptContext docs finished
* README / LICENSE updated
* license text changed to correct BSD wording
* embarassingly, the history.rst is kinda off about release versions.
  tried to make it give readers better outline.
* misc doc updates
* some handler names (eg: 'context', 'all') now forbidden by register_crypt_handler()
* bumped setup.cfg to b1

1 files changed, 21 insertions, 6 deletions

diff --git a/README b/README
index 2eaea34..7e55ecf 100644
--- a/README
+++ b/README
@@ -1,13 +1,28 @@
+.. -*- restructuredtext -*-
+
 ==========================
 The PassLib Python Library
 ==========================
 
+PassLib is a password hash library, which provides cross-platform
+implementations of over 20 password hashing algorithms; as well as a framework for managing
+and migrating existing password hashes. It's designed to be useful
+for any task from quickly verifying a hash found in /etc/shadow,
+to providing full-strength password hashing for multi-user application.
+
+The latest documentation can be found online `XXX`.
+
+Requirements
+-----------
+* Python 2.5 - 2.7
+* PyBCrypt (optional; if bcrypt support is needed)
+* M2Crypto (optional)
+
 Installation
 ------------
-* For detailed installation instructions, see "docs/install.rst"
+To install from source using ``setup.py``::
+
+   python setup.py build
+   sudo python setup.py install
 
-Copyright & License
--------------------
-* (c) 2008-2011 - Assurance Technologies LLC
-* released under BSD license
-* For more license & copyright information, see "docs/copyright.rst"
+For more detailed installation & testing instructions, see "docs/install.rst",