Skip to content

Commit 56ff733

Browse files
authored
Add usage details to readme (#2)
1 parent 5382327 commit 56ff733

File tree

3 files changed

+16
-2
lines changed

3 files changed

+16
-2
lines changed

CHANGELOG.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
Oathtool Dockerfile Changelog
22
==============================
3+
1.0.1 - 06/23/2017
4+
------------------
5+
### Improvements
6+
- Update changelog to include usage
7+
38
1.0.0 - 06/22/2017
49
------------------
510
### Features

Dockerfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ ENTRYPOINT ["/usr/local/bin/oathtool", "--base32", "--totp"]
2525

2626
LABEL com.opengov.maintainer=OpenGov \
2727
28-
com.opengov.version=1.0.0
28+
com.opengov.version=1.0.1

README.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,16 @@
1-
# docker-oathtool
1+
# Oathtool
22
A Debian based Docker image that builds and installs the oath-tool.
33
The oath tool tarball's signature is verified before compiling.
44

5+
For more information on the oath-tool, please see [http://www.nongnu.org/oath-toolkit/](http://www.nongnu.org/oath-toolkit/)
6+
7+
## Usage
8+
The image is set up to generate a TOTP token given a base32 encoded secret.
9+
10+
```
11+
docker run --rm opengovorg/oathtool KDDM8ERQTTYEOHXP
12+
```
13+
514
## Docker Tagging Convention
615
The images should be tagged in the format of:
716

0 commit comments

Comments
 (0)