From 49b1c3e2cfb9b0224712e6891a12950f725c3b13 Mon Sep 17 00:00:00 2001
From: Simeon Simeonov
Date: Tue, 7 Apr 2020 12:24:52 +0200
Subject: Improve README.md and docstrings for Sphinx

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

(limited to 'README.md')

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
 I hope that somebody will find it useful.
 
 
+## Installation
+
+   ```bash
+   pip install pyotp2289
+   ```
+
+
 ## Overview of RFC-2289
 
 RFC-2289 describes a one-time password authentication system (OTP):
@@ -146,6 +153,10 @@ RFC-2289 consists of interactions between them.
    # etc. etc...
    ```
 
+Please visit the [API documentation]
+(http://gnulover.simeonov.no/docs/api/pyotp2289/latest/) for 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:
@@ -164,6 +175,11 @@ existing solutions (f.i. FreeBSD servers), pyotp2289 comes with a simple CLI:
 starting from (and including) 498.
 
 
+## Support and contributing
+
+pyotp2289 is hosted on GitHub: https://github.com/blackm0re/pyotp2289
+
+
 ## Author
 
 Simeon Simeonov - sgs @ Freenode
-- 
cgit v1.3