From ed400a002a2ac64815906a19947d280ccaa4f437 Mon Sep 17 00:00:00 2001 From: SergioCc13 Date: Sun, 30 Aug 2026 13:23:44 +0200 Subject: [PATCH] Add documentation link and badge to README The README (and therefore the PyPI long description) had no pointer to https://pynacl.readthedocs.io/. Add a Latest Documentation badge next to the PyPI badge and a short Documentation section. Closes #877 --- README.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.rst b/README.rst index 30484db8..86fee4c9 100644 --- a/README.rst +++ b/README.rst @@ -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 @@ -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 --------