From c63fca8581352028651f6bc9c2074620c3a27352 Mon Sep 17 00:00:00 2001
From: Marc Cornellà <marc.cornella@live.com>
Date: Fri, 27 Dec 2019 02:47:26 +0100
Subject: otp: add README and use clipcopy

---
 plugins/otp/README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 plugins/otp/README.md

(limited to 'plugins/otp/README.md')

diff --git a/plugins/otp/README.md b/plugins/otp/README.md
new file mode 100644
index 000000000..8331fd02b
--- /dev/null
+++ b/plugins/otp/README.md
@@ -0,0 +1,22 @@
+# otp plugin
+
+This plugin allows you to create one-time passwords using [`oathtool`](https://www.nongnu.org/oath-toolkit/man-oathtool.html),
+able to replace MFA devices. The oathtool key is kept in a GPG-encrypted file so the codes
+can only be generated by a user able to decrypt it.
+
+To use it, add `otp` to the plugins array in your zshrc file:
+```zsh
+plugins=(... otp)
+```
+
+Provided aliases:
+
+- `otp_add_device`: creates a new encrypted storage for an oathtool key and stores it
+  on the disk. For encrypting the key, it will ask for a GPG user ID (your GPG key's
+  email address). Then the OTP key needs to be pasted, followed by a CTRL+D character
+  inserted on an empty line.
+
+- `ot`: generates a MFA code based on the given key and copies it to the clipboard 
+  (on Linux it relies on xsel, on MacOS X it uses pbcopy instead).
+
+The plugin uses `$HOME/.otp` to store its internal files.
-- 
cgit v1.2.3-70-g09d2