Update README.md

This commit is contained in:
Adrien Gallouët 2020-09-14 10:12:22 +02:00 committed by GitHub
parent a58bc76804
commit 908ba9a889
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -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).