PK> "Samuel W. Flint" <swflint@flintfam.org> writes:
>> Hello,
>>
>> In your README, you present a configuration for using rmail, and
>> leaves other users to dig into code do discover what hooks to add
>> autocrypt-mode to. To correct this, I've added a small bit to
>> the README that can (hopefully) help clear it up.
PK> Honestly, looking at the README, I think it's better to just
PK> rewrite the entire "how to use section". I have stopped using
PK> use-package, and have since realized that this convenience for
PK> some might not be that appreciated by others. And in general, it
PK> would be nice to have a minimal configuration for all supported
PK> mail systems.
In that case, I can start on some for GNUS and re-submit the patch.
>> Thanks,
>>
>> Sam
>>
PK> -- Philip K.
Sam
---
README.md | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/README.md b/README.md
index 213b57a..1ff54b8 100644
--- a/README.md+++ b/README.md
@@ -40,6 +40,14 @@ command. In case you want to manually configure your setup, customise
the `autocrypt-accounts` option. Note that configuring a key is
necessary for `autocrypt.el` to function properly.
+`autocrypt-mode` may be added to the following hooks (if not using+`use-package`):++- `gnus-load-hook`+- `message-mode-hook`+- `mu4e-main-mode-hook`+- `rmail-mode-hook`+Bug reports and patches should be sent to my [public inbox].
Copying
--
Samuel W. Flint
4096R/FA13D704
(F50D 862B 4F65 5943 A8C2 EF0E 86C9 3E7A FA13 D704)
λs.(s s) λs.(s s)
** I choose to use plain-text email. It is universally supported,
** please be courteous and do so yourself: useplaintext.email
---
README.md | 23 ++++++++++++++++-------
1 file changed, 16 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
index 213b57a..0cb2b27 100644
--- a/README.md+++ b/README.md
@@ -26,13 +26,8 @@ integration is welcomed.
How to use
----------
-This package is published on [MELPA]. Using `use-package`, one might-configure `autocrypt.el` to read headers using Rmail and inject-headers using `message-mode` as follows:-- (use-package autocrypt- :hook ((rmail-mode . autocrypt-mode)- (message-mode . autocrypt-mode)))+This package is published on [MELPA]. It may also be installed+directly.Autocrypt recommends using a new or separate key pair for signing and
encrypting. If you wish to do so, call the `autocrypt-create-account`
@@ -40,6 +35,20 @@ command. In case you want to manually configure your setup, customise
the `autocrypt-accounts` option. Note that configuring a key is
necessary for `autocrypt.el` to function properly.
+`autocrypt-accounts` is a list of triples, taking the form `(MAIL+FINGERPRINT PREFERENCE)`. `FINGERPRINT` is the key fingerprint used+by `MAIL`, and `PREFERENCE` is what preference should be used, either+`'mutual`, `'no-preference` or `'none` normally; `nil` may be used to+temporarily disable the account.
There is really no need to document this in the README. First of all, it
is not the primary documentation, second of all, this is an internal
representation (defvar instead of defcustom), that the user shouldn't
have to worry about. It might even change between versions, so it's
certainly not something that should be promoted.