summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5811b54..aa30c38 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,13 @@ I decided to license the library under the
21I hope that somebody will find it useful. 21I hope that somebody will find it useful.
22 22
23 23
24## Installation
25
26 ```bash
27 pip install pyotp2289
28 ```
29
30
24## Overview of RFC-2289 31## Overview of RFC-2289
25 32
26RFC-2289 describes a one-time password authentication system (OTP): 33RFC-2289 describes a one-time password authentication system (OTP):
@@ -146,6 +153,10 @@ RFC-2289 consists of interactions between them.
146 # etc. etc... 153 # etc. etc...
147 ``` 154 ```
148 155
156Please visit the [API documentation]
157(http://gnulover.simeonov.no/docs/api/pyotp2289/latest/) for a complete
158reference.
159
149If you don't care about developing applications in Python and only care about 160If you don't care about developing applications in Python and only care about
150generating one-time passwords (tokens / hex digests) and authenticating with 161generating one-time passwords (tokens / hex digests) and authenticating with
151existing solutions (f.i. FreeBSD servers), pyotp2289 comes with a simple CLI: 162existing solutions (f.i. FreeBSD servers), pyotp2289 comes with a simple CLI:
@@ -164,6 +175,11 @@ existing solutions (f.i. FreeBSD servers), pyotp2289 comes with a simple CLI:
164starting from (and including) 498. 175starting from (and including) 498.
165 176
166 177
178## Support and contributing
179
180pyotp2289 is hosted on GitHub: https://github.com/blackm0re/pyotp2289
181
182
167## Author 183## Author
168 184
169Simeon Simeonov - sgs @ Freenode 185Simeon Simeonov - sgs @ Freenode