Skip to content

Add documentation link and badge to README #962

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
SergioCc13 wants to merge 1 commit into from
+10 −0
Closed

Add documentation link and badge to README #962

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ PyNaCl: Python binding to the libsodium library
:target: https://pypi.org/project/PyNaCl/
:alt: Latest Version

.. image:: https://readthedocs.org/projects/pynacl/badge/?version=latest
:target: https://pynacl.readthedocs.io/en/latest/
:alt: Latest Documentation

PyNaCl is a Python binding to `libsodium`_, which is a fork of the
`Networking and Cryptography library`_. These libraries have a stated goal of
improving usability, security and speed. It supports Python 3.8+ as well as
Expand All @@ -14,6 +18,12 @@ PyPy 3.
.. _libsodium: https://github.com/jedisct1/libsodium
.. _Networking and Cryptography library: https://nacl.cr.yp.to/

Documentation
-------------

The complete documentation, including installation instructions and usage
examples, is available at https://pynacl.readthedocs.io/.

Features
--------

Expand Down