summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimeon Simeonov2020-04-07 19:13:01 +0200
committerSimeon Simeonov2020-04-07 19:13:01 +0200
commita46f8180c3ec4bbb7e456d0e70db13c0e3afa25b (patch)
tree4a240055623974a90cd5cbdce90f29429b602cbc
parentd5dcde717daf9774fcf0c73c36888915be348b96 (diff)
Make README.md more pypi.org friendlyv1.0.0
-rw-r--r--README.md19
1 files changed, 8 insertions, 11 deletions
diff --git a/README.md b/README.md
index aa30c38..16cb3f4 100644
--- a/README.md
+++ b/README.md
@@ -9,13 +9,11 @@ It requires no additional libraries.
9## General 9## General
10 10
11The main reason for writing this library was the need to login into my 11The main reason for writing this library was the need to login into my
12FreeBSD servers using the [opiepasswd] 12FreeBSD servers using the [opiepasswd](https://www.freebsd.org/cgi/man.cgi?query=opiepasswd&sektion=1&manpath=freebsd-release-ports)
13(https://www.freebsd.org/cgi/man.cgi?query=opiepasswd&sektion=1&manpath=freebsd-release-ports) 13as described in [FreeBSD Handbook](https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/one-time-passwords.html).
14as described in [FreeBSD Handbook]
15(https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/one-time-passwords.html).
16 14
17I decided to license the library under the 15I decided to license the library under the
18[Simplified BSD License / 2-clause BSD license](LICENSE) and not under the 16[Simplified BSD License / 2-clause BSD license](https://github.com/blackm0re/pyotp2289/blob/master/LICENSE) and not under the
19(L)GPL-3 as I usually do. 17(L)GPL-3 as I usually do.
20 18
21I hope that somebody will find it useful. 19I hope that somebody will find it useful.
@@ -81,7 +79,6 @@ We define the two entities: *client* and *server*. The entire application of
81RFC-2289 consists of interactions between them. 79RFC-2289 consists of interactions between them.
82 80
83 ```python 81 ```python
84 #
85 import getpass # client only 82 import getpass # client only
86 83
87 import otp2289 # client and server 84 import otp2289 # client and server
@@ -153,9 +150,9 @@ RFC-2289 consists of interactions between them.
153 # etc. etc... 150 # etc. etc...
154 ``` 151 ```
155 152
156Please visit the [API documentation] 153Please visit the
157(http://gnulover.simeonov.no/docs/api/pyotp2289/latest/) for a complete 154[API documentation](http://gnulover.simeonov.no/docs/api/pyotp2289/latest/) for
158reference. 155a complete reference.
159 156
160If you don't care about developing applications in Python and only care about 157If you don't care about developing applications in Python and only care about
161generating one-time passwords (tokens / hex digests) and authenticating with 158generating one-time passwords (tokens / hex digests) and authenticating with
@@ -185,10 +182,10 @@ pyotp2289 is hosted on GitHub: https://github.com/blackm0re/pyotp2289
185Simeon Simeonov - sgs @ Freenode 182Simeon Simeonov - sgs @ Freenode
186 183
187 184
188## [License](LICENSE) 185## [License](https://github.com/blackm0re/pyotp2289/blob/master/LICENSE)
189 186
190Copyright (c) 2020, Simeon Simeonov 187Copyright (c) 2020, Simeon Simeonov
191All rights reserved. 188All rights reserved.
192 189
193[Licensed](LICENSE) under the BSD 2-clause. 190[Licensed](https://github.com/blackm0re/pyotp2289/blob/master/LICENSE) under the BSD 2-clause.
194SPDX-License-Identifier: BSD-2-Clause-FreeBSD 191SPDX-License-Identifier: BSD-2-Clause-FreeBSD