hynek/argon2-cffi
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Re-structure README

Browse Source
This commit is contained in:
Hynek Schlawack 2021-08-31 07:54:31 +02:00
parent 1699576ce1
commit 39b89edfa6
2 changed files with 27 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.rst
View File

@ -1,6 +1,6 @@
=================
Argon2 for Python
=================
===================
*Argon2* for Python
===================
.. image:: https://img.shields.io/badge/Docs-Read%20The%20Docs-black
:target: https://argon2-cffi.readthedocs.io/
@ -19,7 +19,7 @@ Argon2 for Python
:alt: Downloads / Month
.. teaser-begin
.. -begin-short-
`Argon2 <https://github.com/p-h-c/phc-winner-argon2>`_ won the `Password Hashing Competition <https://www.password-hashing.net/>`_ and *argon2-cffi* is the simplest way to use it in Python and PyPy:
@ -39,19 +39,29 @@ Argon2 for Python
...
argon2.exceptions.VerifyMismatchError: The password does not match the supplied hash
.. -end-short-
.. -begin-meta-
Project Information
===================
*argon2-cffi*'s documentation lives at `Read the Docs <https://argon2-cffi.readthedocs.io/>`_, the code on `GitHub <https://github.com/hynek/argon2-cffi>`_.
It’s rigorously tested on Python 3.6+, and PyPy3.
It targets Python 3.6 and newer, and PyPy3.
The last version that works with Python 2.7 is 20.1.0, and the last version that works with Python 3.5 is 21.1.0.
It implements *Argon2* version 1.3, as described in
*argon2-cffi* implements *Argon2* version 1.3, as described in
`Argon2: the memory-hard function for password hashing and other applications <https://www.cryptolux.org/images/0/0d/Argon2.pdf>`_.
argon2-cffi for Enterprise
==========================
*argon2-cffi* for Enterprise
----------------------------
Available as part of the Tidelift Subscription.
The maintainers of *argon2-cffi* and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use. `Learn more. <https://tidelift.com/subscription/pkg/pypi-argon2-cffi?utm_source=undefined&utm_medium=referral&utm_campaign=enterprise&utm_term=repo>`_
.. -end-meta-

15
docs/index.rst
View File

@ -1,15 +1,17 @@
``argon2-cffi``
===============
==================================
*argon2-cffi*: *Argon2* for Python
==================================
Release v\ |release| (:doc:`What's new? <changelog>`).
.. include:: ../README.rst
:start-after: teaser-begin
:start-after: -begin-short-
:end-before: -end-short-
User's Guide
------------
============
.. toctree::
:maxdepth: 1
@ -22,8 +24,9 @@ User's Guide
faq
Project Information
-------------------
.. include:: ../README.rst
:start-after: -begin-meta-
:end-before: -end-meta-
.. toctree::
:maxdepth: 1