diff options
Diffstat (limited to 'README.txt')
| -rw-r--r-- | README.txt | 17 |
1 files changed, 17 insertions, 0 deletions
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 |