diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 16 |
1 files changed, 16 insertions, 0 deletions
| @@ -21,6 +21,13 @@ I decided to license the library under the | |||
| 21 | I hope that somebody will find it useful. | 21 | I 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 | ||
| 26 | RFC-2289 describes a one-time password authentication system (OTP): | 33 | RFC-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 | ||
| 156 | Please visit the [API documentation] | ||
| 157 | (http://gnulover.simeonov.no/docs/api/pyotp2289/latest/) for a complete | ||
| 158 | reference. | ||
| 159 | |||
| 149 | If you don't care about developing applications in Python and only care about | 160 | If you don't care about developing applications in Python and only care about |
| 150 | generating one-time passwords (tokens / hex digests) and authenticating with | 161 | generating one-time passwords (tokens / hex digests) and authenticating with |
| 151 | existing solutions (f.i. FreeBSD servers), pyotp2289 comes with a simple CLI: | 162 | existing 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: | |||
| 164 | starting from (and including) 498. | 175 | starting from (and including) 498. |
| 165 | 176 | ||
| 166 | 177 | ||
| 178 | ## Support and contributing | ||
| 179 | |||
| 180 | pyotp2289 is hosted on GitHub: https://github.com/blackm0re/pyotp2289 | ||
| 181 | |||
| 182 | |||
| 167 | ## Author | 183 | ## Author |
| 168 | 184 | ||
| 169 | Simeon Simeonov - sgs @ Freenode | 185 | Simeon Simeonov - sgs @ Freenode |
