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 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 README.txt

(limited to '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
-- 
cgit v1.2.3