From 908ba9a889790b3eb3ebe2f5e8f707f3fc6c61a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adrien=20Gallou=C3=ABt?= Date: Mon, 14 Sep 2020 10:12:22 +0200 Subject: [PATCH] Update README.md --- README.md | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3918b31..1a613d8 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,33 @@ # totp A tiny command line utility to generate OTP tokens - $ echo -n JBSWY3DPEHPK3PXP | base32 -d | ./totp - 506471 +## Build and install + +Clone the repository: + + $ git clone https://github.com/angt/totp + $ cd totp + +Then, run as `root`: + + # make install + +As usual, you can customize the destination with `DESTDIR` and `prefix`. + +## Usage + +It has been thought for [secret](https://github.com/angt/secret), +maybe it will be directly integrated in a future version, in the meantime: + +### Add a new TOTP key + + $ echo -n JBSWY3DPEHPK3PXP | base32 -d | secret set test/totp + +### Generate a TOTP token + + $ secret show test/totp | totp + $ 123456 + +--- +For feature requests and bug reports, +please create an [issue](https://github.com/angt/totp/issues).