From f649a03c1be597a4da12ee4d503043b153fe084b Mon Sep 17 00:00:00 2001
From: Tom Cocagne <devnull@localhost>
Date: Wed, 1 Dec 2010 09:44:20 -0500
Subject: updated documentation

---
 README.txt  | 17 +++++++++++++++++
 doc/srp.rst | 43 +++++++++++++++++++++++++------------------
 2 files changed, 42 insertions(+), 18 deletions(-)
 create mode 100644 README.txt

diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..1e9dcf7
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,17 @@
+
+This package provides a Python Implementation of the Secure Remote Password
+Protocol. It consists of 3 modules: A pure Python implementation, A ctypes
++ OpenSSL implementation, and a C extension module. The ctypes/extension 
+modules are approximately 10x faster than the pure Python implementation
+and can take advantage of multiple CPUs. The ctypes/extension module will
+be used if available, otherwise the library will fall back to the pure
+Python implementation.
+
+
+Installation:
+   python setup.py install
+   
+   
+Documentation:
+   cd doc
+   sphinx-build -b html . <desired output directory>
\ No newline at end of file
diff --git a/doc/srp.rst b/doc/srp.rst
index ef55add..dafa45d 100644
--- a/doc/srp.rst
+++ b/doc/srp.rst
@@ -46,24 +46,31 @@ See http://srp.stanford.edu/ for a full description of the SRP protocol.
 
 Constants
 ---------
-==============  ==============
-Hash Algorithm  Number of Bits
-==============  ==============
-SHA1            160
-SHA224          224
-SHA256          256
-SHA384          384
-SHA512          512
-==============  ==============
-
-=================
-Prime Number Size
-=================
-NG_1024  
-NG_2048   
-NG_4096   
-NG_CUSTOM 
-=================
+
+.. table:: Hashing Algorithm Constants
+
+  ==============  ==============
+  Hash Algorithm  Number of Bits
+  ==============  ==============
+  SHA1            160
+  SHA224          224
+  SHA256          256
+  SHA384          384
+  SHA512          512
+  ==============  ==============
+
+Larger hashing algorithms will result in larger session keys.
+
+.. table:: Prime Number Constants
+
+  ================= ==============
+  Prime Number Size Number of Bits
+  ================= ==============
+  NG_1024           1024
+  NG_2048           2048
+  NG_4096           4096
+  NG_CUSTOM         User Supplied
+  ================= ==============
 
 If NG_CUSTOM is used, the 'n_hex' and 'g_hex' parameters are required.
 These parameters must be ASCII text containing hexidecimal notation of the
-- 
cgit v1.2.3