Skip to content

Commit 39b89ed

Browse files
committed
Re-structure README
1 parent 1699576 commit 39b89ed

File tree

2 files changed

+27
-14
lines changed

2 files changed

+27
-14
lines changed

README.rst

+18-8
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
=================
2-
Argon2 for Python
3-
=================
1+
===================
2+
*Argon2* for Python
3+
===================
44

55
.. image:: https://img.shields.io/badge/Docs-Read%20The%20Docs-black
66
:target: https://argon2-cffi.readthedocs.io/
@@ -19,7 +19,7 @@ Argon2 for Python
1919
:alt: Downloads / Month
2020

2121

22-
.. teaser-begin
22+
.. -begin-short-
2323
2424
`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:
2525

@@ -39,19 +39,29 @@ Argon2 for Python
3939
...
4040
argon2.exceptions.VerifyMismatchError: The password does not match the supplied hash
4141
42+
.. -end-short-
43+
44+
45+
.. -begin-meta-
46+
47+
Project Information
48+
===================
49+
4250

4351
*argon2-cffi*'s documentation lives at `Read the Docs <https://argon2-cffi.readthedocs.io/>`_, the code on `GitHub <https://github.com/hynek/argon2-cffi>`_.
44-
It’s rigorously tested on Python 3.6+, and PyPy3.
4552

53+
It targets Python 3.6 and newer, and PyPy3.
4654
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.
4755

48-
It implements *Argon2* version 1.3, as described in
56+
*argon2-cffi* implements *Argon2* version 1.3, as described in
4957
`Argon2: the memory-hard function for password hashing and other applications <https://www.cryptolux.org/images/0/0d/Argon2.pdf>`_.
5058

5159

52-
argon2-cffi for Enterprise
53-
==========================
60+
*argon2-cffi* for Enterprise
61+
----------------------------
5462

5563
Available as part of the Tidelift Subscription.
5664

5765
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>`_
66+
67+
.. -end-meta-

docs/index.rst

+9-6
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
1-
``argon2-cffi``
2-
===============
1+
==================================
2+
*argon2-cffi*: *Argon2* for Python
3+
==================================
34

45
Release v\ |release| (:doc:`What's new? <changelog>`).
56

67

78
.. include:: ../README.rst
8-
:start-after: teaser-begin
9+
:start-after: -begin-short-
10+
:end-before: -end-short-
911

1012

1113
User's Guide
12-
------------
14+
============
1315

1416
.. toctree::
1517
:maxdepth: 1
@@ -22,8 +24,9 @@ User's Guide
2224
faq
2325

2426

25-
Project Information
26-
-------------------
27+
.. include:: ../README.rst
28+
:start-after: -begin-meta-
29+
:end-before: -end-meta-
2730

2831
.. toctree::
2932
:maxdepth: 1

0 commit comments

Comments
 (0)