branch: elpa/age
commit 79fdde8ecc05085182bb5585ad88bcbc1f5a62f3
Author: Bas Alberts <[email protected]>
Commit: Bas Alberts <[email protected]>
Add a screenshot to README
---
README.org | 10 ++++++----
img/emacs-age.png | Bin 0 -> 436289 bytes
2 files changed, 6 insertions(+), 4 deletions(-)
diff --git a/README.org b/README.org
index 3f80674dde6..7753457031a 100644
--- a/README.org
+++ b/README.org
@@ -1,16 +1,18 @@
* age.el: transparent age encryption/decryption
+#+html:<p align="center"><img src="img/emacs-age.png"/></p>
+
age.el is intended to provide transparent age[1] based file encryption
and decryption in Emacs. As such age.el does not support all
age CLI based use cases. Rather age.el assumes you have configured
a default identity and a default recipient, e.g. based off your
-ssh private key and ssh public key in ~/.ssh/id_rsa[.pub], which
+ssh private key and ssh public key in ~.ssh/id_rsa[.pub]~, which
is the default setting.
The main use case is for folks who like to e.g. encrypt their Org
notes and things of that nature. Since age.el provides a direct
port of EPG/EPA functionality it can support all roles that .gpg
-files can support in Emacs, e.g. ~/.authinfo.age should work fine as well.
+files can support in Emacs, e.g. ~.authinfo.age~ should work fine as well.
[1]: https://github.com/FiloSottile/age
@@ -37,8 +39,8 @@ M-x save-buffer RET
#+end_src
Will create an age encrypted file named test.age in the ~/tmp~
-directory. It will be encrypted to a recipient of ~~/.ssh/id_rsa.pub~
-by default and decrypted with an identity of ~~/.ssh/id_rsa~ by default.
+directory. It will be encrypted to a recipient of ~.ssh/id_rsa.pub~
+by default and decrypted with an identity of ~.ssh/id_rsa~ by default.
You can customize the default key values via ~age-default-recipient~ and
~age-default-identity~, respectively.
diff --git a/img/emacs-age.png b/img/emacs-age.png
new file mode 100644
index 00000000000..158b0ea2497
Binary files /dev/null and b/img/emacs-age.png differ
