diff options
author | Hynek Schlawack <hs@ox.cx> | 2016-03-19 07:42:15 +0100 |
---|---|---|
committer | Hynek Schlawack <hs@ox.cx> | 2016-03-19 07:42:30 +0100 |
commit | ac7fbb8e3f5a3559cec814d29abfa8ec56026360 (patch) | |
tree | 8c11dd73cd1be16ec60e2d4088597ff3003a4f09 /README.rst | |
parent | 9dff5c4ce371a585f922f1ed9398cec06a804a9e (diff) | |
download | pyopenssl-ac7fbb8e3f5a3559cec814d29abfa8ec56026360.tar.gz |
Some README polishing
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 25 |
1 files changed, 18 insertions, 7 deletions
@@ -2,9 +2,9 @@ pyOpenSSL -- A Python wrapper around the OpenSSL library ======================================================== -.. image:: https://readthedocs.org/projects/pyopenssl/badge/?version=latest +.. image:: https://readthedocs.org/projects/pyopenssl/badge/?version=stable :target: https://pyopenssl.readthedocs.org/ - :alt: Latest Docs + :alt: Stable Docs .. image:: https://travis-ci.org/pyca/pyopenssl.svg?branch=master :target: https://travis-ci.org/pyca/pyopenssl @@ -17,16 +17,27 @@ pyOpenSSL -- A Python wrapper around the OpenSSL library High-level wrapper around a subset of the OpenSSL library. Includes -* SSL.Connection objects, wrapping the methods of Python's portable sockets +* ``SSL.Connection`` objects, wrapping the methods of Python's portable sockets * Callbacks written in Python * Extensive error-handling mechanism, mirroring OpenSSL's error codes ... and much more. -See the file INSTALL.rst for installation instructions. +You can find more information in the documentation_. +Development takes place on GitHub_. -See https://github.com/pyca/pyopenssl for development. -See https://pyopenssl.readthedocs.org for documentation. +Discussion +========== -See https://mail.python.org/mailman/listinfo/pyopenssl-users for the discussion mailing list. +If you run into bugs, you can file them in our `issue tracker`_. + +We maintain a cryptography-dev_ mailing list for both user and development discussions. + +You can also join ``#cryptography-dev`` on Freenode to ask questions or get involved. + + +.. _documentation: https://pyopenssl.readthedocs.org/ +.. _`issue tracker`: https://github.com/pyca/pyopenssl/issues +.. _cryptography-dev: https://mail.python.org/mailman/listinfo/cryptography-dev +.. _GitHub: https://github.com/pyca/pyopenssl |