branch: elpa/base32
commit e113a73b9b27768602e3b721b6e0112801e215cf
Author: Vivek Das Mohapatra <[email protected]>
Commit: Vivek Das Mohapatra <[email protected]>
Add more details to the commentary and README
---
README | 10 +++++-----
totp-auth.el | 27 +++++++++++++++++++++++++--
2 files changed, 30 insertions(+), 7 deletions(-)
diff --git a/README b/README
index 17bc655506..3049d82af4 100644
--- a/README
+++ b/README
@@ -1,12 +1,12 @@
-totp.el - Time-based One Time Password support for emacs
+totp-auth.el - Time-based One Time Password support for emacs
This package generates RFC6238 Time-based One Time Passwords
and displays them (as well as optionally copying them to
-the clipbpoard/primary selection), updating them as they expire.
+the clipboard/primary selection), updating them as they expire.
-It stores and retrieves the shared secrets used to generate TOTP
-tokens based on ‘auth-sources’ and/or the freedesktop secrets API
-(aka Gnome Keyring or KWallet).
+It retrieves the shared secrets used to generate TOTP tokens
+with ‘auth-sources’ and/or the freedesktop secrets API (aka
+Gnome Keyring or KWallet).
You can call it with the command ‘totp’, ie:
diff --git a/totp-auth.el b/totp-auth.el
index 4e2b152db7..18bfc2a827 100644
--- a/totp-auth.el
+++ b/totp-auth.el
@@ -9,8 +9,31 @@
;; Package-Requires: ((emacs "27.1"))
;;; Commentary:
-;; Import TOTP secrets, store and fetch them from auth-sources, and
-;; generate TOTP (time-based one time password) tokens from them.
+;; totp-auth.el - Time-based One Time Password support for emacs
+;;
+;; This package generates RFC6238 Time-based One Time Passwords
+;; and displays them (as well as optionally copying them to
+;; the clipboard/primary selection), updating them as they expire.
+;;
+;; It retrieves the shared secrets used to generate TOTP tokens
+;; with ‘auth-sources’ and/or the freedesktop secrets API (aka
+;; Gnome Keyring or KWallet).
+;;
+;; You can call it with the command ‘totp’, ie:
+;;
+;; M-x totp RET
+;;
+;; You can tab-complete based on the label of the secret and a
+;; buffer displaying the token will be displayed (and updated as
+;; the displayed token expires).
+;;
+;; If you want to import TOTP secrets from other apps you can call:
+;;
+;; M-x totp-import-file RET
+;;
+;; If you want the latest generated token automatically
+;; copied to your GUI's selection for easy pasting, you
+;; can customize ‘totp-auto-copy-password’.
;;; Code:
(eval-and-compile
