commit ef7237e09e38d3564c818079c214410fe207ce19
parent f8c16a3a1bff7ecbe18c57218f692da69a50a8e9
Author: nolash <dev@holbrook.no>
Date: Sat, 17 Oct 2020 16:23:48 +0200
Correct readme bug, decrypt is default
Diffstat:
1 file changed, 10 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -92,11 +92,19 @@ Values can be **GNUPG** encrypted by saving them in individual encrypted files p
BAR_BAZ = !gpg(foo_bar_baz.asc)
```
-Decryption mode must be explicitly activated:
+Decryption mode is on by default, and can be deactivated on instantiation:
```
->>> c = config.Config('/path/to/config/dir', decrypt=True)
+>>> c = config.Config('/path/to/config/dir')
+>>> c.process()
+>>> c.get()
+666
+>>> c = config.Config('/path/to/config/dir', decrypt=False)
+>>> c.process()
+>>> c.get()
+!gpg(foo_bar_baz.asc)
```
+
The user keyring in the default location is used for decryption, which may be overridden as usual with the `GNUPGHOME` environment variable.