Include badges instead of text for indicating version support
Marco Ricci commited on 2024-10-21 14:42:39
Zeige 1 geänderte Dateien mit 12 Einfügungen und 1 Löschungen.
In the tutorials, instead of including a statically compiled text list of the current `derivepassphrase` version and the supported Python versions, include a `shields.io` badge that displays precisely this info, sourced from PyPI.
- docs/tutorials/basic-setup-passphrase.md 4229770..5e0e71d
| ... | ... |
@@ -40,7 +40,11 @@ We will assume the following three services with the following passphrase polici |
| 40 | 40 |
|
| 41 | 41 |
## Installing `derivepassphrase` |
| 42 | 42 |
|
| 43 |
-You will need Python 3.9 or later, and a package installer such as `pip` (bundled with Python), `pipx` or similar. |
|
| 43 |
+You will need Python 3, and a package installer such as `pip` (bundled with Python), `pipx` or similar. |
|
| 44 |
+ |
|
| 45 |
+??? info "Info: Current supported Python versions" |
|
| 46 |
+ |
|
| 47 |
+ ![See PyPI.][CURRENT_PYTHON] |
|
| 44 | 48 |
|
| 45 | 49 |
--- |
| 46 | 50 |
|
| ... | ... |
@@ -71,6 +75,13 @@ derivepassphrase, version 0.3.0 |
| 71 | 75 |
|
| 72 | 76 |
(…or similar output.) |
| 73 | 77 |
|
| 78 |
+??? info "Info: Current `derivepassphrase` version" |
|
| 79 |
+ |
|
| 80 |
+ ![See PyPI.][CURRENT_VERSIONS] |
|
| 81 |
+ |
|
| 82 |
+[CURRENT_VERSIONS]: https://img.shields.io/pypi/v/derivepassphrase.svg?label=derivepassphrase |
|
| 83 |
+[CURRENT_PYTHON]: https://img.shields.io/pypi/pyversions/derivepassphrase.svg |
|
| 84 |
+ |
|
| 74 | 85 |
## Choosing a master passphrase |
| 75 | 86 |
|
| 76 | 87 |
`derivepassphrase` uses a master passphrase `MP`, and derives all other passphrases `P` from `MP`. |
| 77 | 88 |