Add usage details to readme (#2)

OpenGov · Jun 23, 2017 · 56ff733 · 56ff733
1 parent 5382327
commit 56ff733
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 Oathtool Dockerfile Changelog
 ==============================
+1.0.1 - 06/23/2017
+------------------
+### Improvements
+- Update changelog to include usage
+
 1.0.0 - 06/22/2017
 ------------------
 ### Features

diff --git a/Dockerfile b/Dockerfile
@@ -25,4 +25,4 @@ ENTRYPOINT ["/usr/local/bin/oathtool", "--base32", "--totp"]
 
 LABEL com.opengov.maintainer=OpenGov \
       com.opengov.contact=devops@opengov.com \
-      com.opengov.version=1.0.0
+      com.opengov.version=1.0.1
diff --git a/README.md b/README.md
@@ -1,7 +1,16 @@
-# docker-oathtool
+# Oathtool
 A Debian based Docker image that builds and installs the oath-tool.
 The oath tool tarball's signature is verified before compiling.
 
+For more information on the oath-tool, please see [http://www.nongnu.org/oath-toolkit/](http://www.nongnu.org/oath-toolkit/)
+
+## Usage
+The image is set up to generate a TOTP token given a base32 encoded secret.
+
+```
+docker run --rm opengovorg/oathtool KDDM8ERQTTYEOHXP
+```
+
 ## Docker Tagging Convention
 The images should be tagged in the format of: