diff --git a/README.md b/README.md index fdeba53..7bb7f1c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Argon2 for Python +# *argon2-cffi*: Argon2 for Python [![Documentation](https://img.shields.io/badge/Docs-Read%20The%20Docs-black)](https://argon2-cffi.readthedocs.io/) [![License: MIT](https://img.shields.io/badge/license-MIT-C06524)](https://github.com/hynek/argon2-cffi/blob/main/LICENSE) @@ -6,7 +6,8 @@ [![PyPI version](https://img.shields.io/pypi/v/argon2-cffi)](https://pypi.org/project/argon2-cffi/) [![Downloads / Month](https://static.pepy.tech/personalized-badge/argon2-cffi?period=month&units=international_system&left_color=grey&right_color=blue&left_text=Downloads%20/%20Month)](https://pepy.tech/project/argon2-cffi) - + + [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: @@ -26,7 +27,7 @@ Traceback (most recent call last): argon2.exceptions.VerifyMismatchError: The password does not match the supplied hash ``` - + ## Project Links @@ -34,8 +35,10 @@ argon2.exceptions.VerifyMismatchError: The password does not match the supplied - [**GitHub**](https://github.com/hynek/argon2-cffi) - [**Documentation**](https://argon2-cffi.readthedocs.io/) - [**Changelog**](https://github.com/hynek/argon2-cffi/blob/main/CHANGELOG.md) +- [**Funding**](https://hynek.me/say-thanks/) - The low-level Argon2 CFFI bindings are maintained in the separate [*argon2-cffi-bindings*](https://github.com/hynek/argon2-cffi-bindings) project. + ## Credits diff --git a/docs/index.md b/docs/index.md index c5f7047..5f033df 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,14 +3,22 @@ Release **{sub-ref}`release`** ([What's new?](https://github.com/hynek/argon2-cffi/blob/main/CHANGELOG.md)) ```{include} ../README.md -:end-before: -:start-after: +:end-before: +:start-after: ``` +If you don't know where to start, learn {doc}`argon2` and take it from there! + + +## Indices and Tables + +- {doc}`api` +- {ref}`genindex` +- {ref}`search` -## User's Guide ```{toctree} +:hidden: :maxdepth: 1 argon2 @@ -23,18 +31,6 @@ faq ``` -## Project Links - -```{include} ../README.md -:start-after: '## Project Links' -``` - - -## Indices and tables - -- {ref}`genindex` -- {ref}`search` - ```{toctree} :hidden: :caption: Meta diff --git a/pyproject.toml b/pyproject.toml index f4b5c82..7a47413 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -71,22 +71,34 @@ content-type = "text/markdown" [[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]] path = "README.md" +start-after = "\n" +end-before = "\n" [[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]] text = """ +## Release Information -## Release Information for """ +""" [[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]] path = "CHANGELOG.md" start-after = "" -pattern = "## ([^\n]+?\n\n)###" +pattern = "\n(###.+?\n)## " [[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]] -path = "CHANGELOG.md" -start-after = "" -pattern = "\n(###.+?\n)## " +text = """ +--- + +[→ Full Changelog](https://github.com/hynek/svcs/blob/main/CHANGELOG.md) + + +""" + +[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]] +path = "README.md" +start-at = "## Credits" + [tool.pytest.ini_options]