branch: elpa/age
commit 5729913e067dfca294547795541b1b156a2e2c9b
Author: Bas Alberts <[email protected]>
Commit: Bas Alberts <[email protected]>
Add example to README
---
README.org | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/README.org b/README.org
index c04a3d890b5..accba4b426b 100644
--- a/README.org
+++ b/README.org
@@ -23,9 +23,26 @@ Put age.el somewhere in your load-path and:
(age-file-enable)
#+end_src
+You can now open, edit, and save Age encryted files from Emacs as
+long as they contain the .age extension.
+
age.el also supports creating new .age files through find-file and
they will be encrypted to your default recipient on first save.
+Example:
+
+#+begin_src
+M-x find-file RET /tmp/test.age RET
+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.
+
+You can customize the default key values via age-default-recipient and
+age-default-identity, respectively.
+
* Known issues
The Age CLI does not support pinentry by design. Users are encouraged
