about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 18 insertions, 15 deletions
diff --git a/README.md b/README.md
index df58aaf..9d5d710 100644
--- a/README.md
+++ b/README.md
@@ -8,13 +8,14 @@ that are about to expire and provides an Atom feed for notification.
 ### Expiration checking
 
 ```console
-$ scadere check --help
-Usage: scadere check [-h] [-d DAYS] [-o PATH] HOST[:PORT] [HOST[:PORT] ...]
+$ scadere-check --help
+Usage: scadere-check [-h] [-v] [-d DAYS] [-o PATH] HOST[:PORT]...
 
 Check TLS certificate expiration of HOST, where PORT defaults to 443.
 
 Options:
   -h, --help            show this help message and exit
+  -v, --version         show program's version number and exit
   -d DAYS, --days=DAYS  days before expiration (default to 7)
   -o PATH, --output=PATH
                         output file (default to stdout)
@@ -25,15 +26,16 @@ It is recommended to run `scadere check` as a cron job.
 ### Expiration notification
 
 ```console
-$ scadere listen --help
-Usage: scadere listen [-h] INPUT URL [[HOST][:PORT]]
+$ scadere-listen --help
+Usage: scadere-listen [-h] [-v] INPUT URL [[HOST][:PORT]]
 
 Serve the TLS certificate expiration feed from INPUT file
 for base URL at HOST:PORT, where HOST defaults to localhost
 and PORT is selected randomly if not specified.
 
 Options:
-  -h, --help  show this help message and exit
+  -h, --help     show this help message and exit
+  -v, --version  show program's version number and exit
 ```
 
 ## Hacking
@@ -46,15 +48,17 @@ on any Python package, it is safe to be tested in-tree:
 
 ## Contributing
 
-Please make sure that patches maintain the full branch [coverage]
-and the [hobgoblins][flake8] are happy:
+Issues should be reported to [chung@loa.loang.net][loang mailing list].
+
+The mailing list also welcomes patches.  Please maintain
+the full branch [coverage] and keep the [hobgoblins][flake8] happy:
 
     PYTHONPATH=src coverage run
     coverage report
     flake8
 
-Patches should be sent to [chung@loa.loang.net][loang mailing list]
-using [`git send-email`][git send-email], with the following configuration:
+Patches should be sent using [`git send-email`][git send-email]
+with the following configuration:
 
     git config sendemail.to 'chung@loa.loang.net'
     git config format.subjectPrefix 'PATCH scadere'
@@ -63,17 +67,16 @@ using [`git send-email`][git send-email], with the following configuration:
 
 ![AGPLv3](https://www.gnu.org/graphics/agplv3-155x51.png)
 
-Scadere is free software: you can redistribute it and/or modify it
-under the terms of the GNU [Affero General Public License][agplv3] as
-published by the Free Software Foundation, either version 3 of the License,
-or (at your option) any later version.
+Scadere is free software: you can redistribute and/or modify it
+under the terms of the GNU [Affero General Public License][agpl]
+version 3 or later.
 
 [pytest]: https://docs.pytest.org
 [pytest-asyncio]: https://pytest-asyncio.rtfd.io
 [Hypothesis]: https://hypothesis.rtfd.io
 [trustme]: https://trustme.rtfd.io
+[loang mailing list]: https://loa.loang.net/chung
 [coverage]: https://coverage.rtfd.io
 [flake8]: https://flake8.pycqa.org
-[loang mailing list]: https://loa.loang.net/chung
 [git send-email]: https://git-send-email.io
-[agplv3]: https://www.gnu.org/licenses/agpl-3.0.html
+[agpl]: https://www.gnu.org/licenses/agpl