Reformat the code with annotations and new code style

author: Simeon Simeonov 2022-03-21 13:25:26 +0100
committer: Simeon Simeonov 2022-03-21 13:25:26 +0100
commit: 12c5e38691b24d12a8fc9605e3b93fac86d461ae (patch)
tree: e27a66b696bf42b61fe2c27e864e9a73c9b57d4a /README.md
parent: 9179abf6c4b3e3eb2c991cbbd74738e160b910cc (diff)
1 files changed, 10 insertions, 18 deletions
diff --git a/README.md b/README.md
index 7ba6487..a3b00c5 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # pyotp2289
-pyotp2289 is a pure Python 3 implementation of "A One-Time Password System" -
+*pyotp2289* is a pure Python 3 implementation of "A One-Time Password System" -
 RFC-2289.
 It requires no additional libraries.
@@ -30,7 +30,7 @@ I hope that somebody will find it useful.
 ### FreeBSD
-`pyotp2289` is included in the official ports-tree.
+*pyotp2289* is included in the official ports-tree.
   ```bash
   cd /usr/ports/security/py-pyotp2289
@@ -41,21 +41,13 @@ I hope that somebody will find it useful.
 ### Gentoo
   ```bash
-   layman -a sgs
+   # add sgs' custom repository using app-eselect/eselect-repository
-   emerge dev-python/pyotp2289
+   eselect repository add sgs
-   ```
-### Fedora ( >= 31)
-Set up a custom repo as described: https://pkg.pichove.org/Fedora/README.txt
+   # ... or using app-portage/layman (obsolete)
+   layman -a sgs
-Key fingerprint: A664 5797 661E 2F47 3DD3  FF06 BCE7 0555 C3BB 08F7
-Install the package:
-   ```bash
+   emerge dev-python/pyotp2289
-   sudo dnf install python3-pyotp2289
   ```
@@ -189,7 +181,7 @@ a complete reference.
 If you don't care about developing applications in Python and only care about
 generating one-time passwords (tokens / hex digests) and authenticating with
-existing solutions (f.i. FreeBSD servers), pyotp2289 comes with a simple CLI:
+existing solutions (f.i. FreeBSD servers), *pyotp2289* comes with a simple CLI:
   ```bash
   python -m otp2289 --generate-otp-response -f token -i 498 -s TesT
@@ -207,7 +199,7 @@ starting from (and including) 498.
 ## Support and contributing
-pyotp2289 is hosted on GitHub: https://github.com/blackm0re/pyotp2289
+*pyotp2289* is hosted on GitHub: https://github.com/blackm0re/pyotp2289
 ## Author
@@ -217,7 +209,7 @@ Simeon Simeonov - sgs @ LiberaChat
 ## [License](https://github.com/blackm0re/pyotp2289/blob/master/LICENSE)
-Copyright (c) 2020, Simeon Simeonov
+Copyright (c) 2020-2022 Simeon Simeonov
 All rights reserved.
 [Licensed](https://github.com/blackm0re/pyotp2289/blob/master/LICENSE) under the BSD 2-clause.
author	Simeon Simeonov	2022-03-21 13:25:26 +0100
committer	Simeon Simeonov	2022-03-21 13:25:26 +0100
commit	12c5e38691b24d12a8fc9605e3b93fac86d461ae (patch)
tree	e27a66b696bf42b61fe2c27e864e9a73c9b57d4a /README.md
parent	9179abf6c4b3e3eb2c991cbbd74738e160b910cc (diff)

diff --git a/README.md b/README.md index 7ba6487..a3b00c5 100644 --- a/README.md +++ b/README.md
@@ -1,6 +1,6 @@
1	# pyotp2289	1	# pyotp2289
2		2
3	pyotp2289 is a pure Python 3 implementation of "A One-Time Password System" -	3	pyotp2289 is a pure Python 3 implementation of "A One-Time Password System" -
4	RFC-2289.	4	RFC-2289.
5		5
6	It requires no additional libraries.	6	It requires no additional libraries.
@@ -30,7 +30,7 @@ I hope that somebody will find it useful.
30		30
31	### FreeBSD	31	### FreeBSD
32		32
33	`pyotp2289` is included in the official ports-tree.	33	pyotp2289 is included in the official ports-tree.
34		34
35	```bash	35	```bash
36	cd /usr/ports/security/py-pyotp2289	36	cd /usr/ports/security/py-pyotp2289
@@ -41,21 +41,13 @@ I hope that somebody will find it useful.
41	### Gentoo	41	### Gentoo
42		42
43	```bash	43	```bash
44	layman -a sgs	44	# add sgs' custom repository using app-eselect/eselect-repository
45	emerge dev-python/pyotp2289	45	eselect repository add sgs
46	```
47
48
49	### Fedora ( >= 31)
50		46
51	Set up a custom repo as described: https://pkg.pichove.org/Fedora/README.txt	47	# ... or using app-portage/layman (obsolete)
52		48	layman -a sgs
53	Key fingerprint: A664 5797 661E 2F47 3DD3 FF06 BCE7 0555 C3BB 08F7
54
55	Install the package:
56		49
57	```bash	50	emerge dev-python/pyotp2289
58	sudo dnf install python3-pyotp2289
59	```	51	```
60		52
61		53
@@ -189,7 +181,7 @@ a complete reference.
189		181
190	If you don't care about developing applications in Python and only care about	182	If you don't care about developing applications in Python and only care about
191	generating one-time passwords (tokens / hex digests) and authenticating with	183	generating one-time passwords (tokens / hex digests) and authenticating with
192	existing solutions (f.i. FreeBSD servers), pyotp2289 comes with a simple CLI:	184	existing solutions (f.i. FreeBSD servers), pyotp2289 comes with a simple CLI:
193		185
194	```bash	186	```bash
195	python -m otp2289 --generate-otp-response -f token -i 498 -s TesT	187	python -m otp2289 --generate-otp-response -f token -i 498 -s TesT
@@ -207,7 +199,7 @@ starting from (and including) 498.
207		199
208	## Support and contributing	200	## Support and contributing
209		201
210	pyotp2289 is hosted on GitHub: https://github.com/blackm0re/pyotp2289	202	pyotp2289 is hosted on GitHub: https://github.com/blackm0re/pyotp2289
211		203
212		204
213	## Author	205	## Author
@@ -217,7 +209,7 @@ Simeon Simeonov - sgs @ LiberaChat
217		209
218	## [License](https://github.com/blackm0re/pyotp2289/blob/master/LICENSE)	210	## [License](https://github.com/blackm0re/pyotp2289/blob/master/LICENSE)
219		211
220	Copyright (c) 2020, Simeon Simeonov	212	Copyright (c) 2020-2022 Simeon Simeonov
221	All rights reserved.	213	All rights reserved.
222		214
223	[Licensed](https://github.com/blackm0re/pyotp2289/blob/master/LICENSE) under the BSD 2-clause.	215	[Licensed](https://github.com/blackm0re/pyotp2289/blob/master/LICENSE) under the BSD 2-clause.