Home

git-age @main - refs - log -
-
https://git.jolheiser.com/git-age.git
git-crypt, but with age
tree log patch
docs: update readme Signed-off-by: jolheiser <john.olheiser@gmail.com>
Signature
-----BEGIN PGP SIGNATURE----- iQIzBAABCgAdFiEEgqEQpE3xoo1QwJO/uFOtpdp7v3oFAmTMBf0ACgkQuFOtpdp7 v3omSg/8C1ixwOZOt7MkeZ/Xt9NA5tKuhlEIf3O38MgOc05UKfXdmcmLLX8n0s8l +MPB/QVBVNie2zlsxlotaqLqK7q5z6cQ92bHmu/GCMB3ni+EJay3dJ1f6lHiiD3d sgYA3oJTx5G+mTs2J97rohHt4u22Z7KHrKNVnRXOQ+JWVttYkw29CQPaM7H68xsq vJ5G/CSRuTk0QduB09YZB/CaAisSvmPXTWQUPbhgF3SriMUHkSvpq+fkf355islB OWAlCZ9ch6rDBbENrZ6LlH4r1PieatIKr/fZRqnqwu4ZZX0/RtziB15Af3datsyq aSPBGrCr4rDeV9Fh+Z24nXVO+2CVzQKE7I0gyGfWUWLOy8l0vZS8knXx5sRN5HY2 gMq4h7vJKQr3LLgjYMsd3Cbgx25oUr28MwdnTdvWOhAtg/cYO50O1extvDtZ76B9 GIz4PIG+D/33rueXE/EzIiaL6lhIZMmqrsMUnMTGQhNahB3e5Q6lSsfXvUkg0tyu 6YoesNXZVwy3rmYr/N+IKfG5zaPNdjZ1i+n5huPLRiFiECjIGccVL6LJ8TCK6ec0 pWdCd4P4rcdd3INWT/8zJWdIUGI2QUdAkDU93Bc8HZx1dIRm8Vb8ryK0jk9XxhIr eMSKtaLEWmZhWWl24gF9bABXzVRJU29EZiNwnvrwJ1KwW1ZnR6c= =uAIW -----END PGP SIGNATURE-----
jolheiser <john.olheiser@gmail.com>
1 year ago
1 changed files, 30 additions(+), 0 deletions(-)
M README.md -> README.md
diff --git a/README.md b/README.md
index ba044d4b2d59161222c7ae199c22ae65d45d8a67..7dfc2466ad88997785b2443d97283c7890da402c 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,36 @@ # git-age
 
 This is a Go port of [git-agecrypt](https://github.com/vlaci/git-agecrypt) with some slight modifications.
 
+Echoed from the original project:
+
+> ## Why should I use this?
+>
+> Short answer: you probably shouldn't. Before considering this approach, take a look at [SOPS](https://github.com/mozilla/sops) and [Hashicorp Vault](https://www.vaultproject.io/) if they are better suited for the problem at hand. **They have a clear security advantage** over `git-age`.
+> 
+> The one use-case where it makes sense to use `git-age` instead is when you want to keep some files secret on a (potentially public) git remote, but you need to have the plaintext in the local working tree because you cannot hook into the above tools for your workflow. **Being lazy is not an excuse to use this software.**
+
+## Install
+
+1. Install `git-age` in your `PATH`
+2. `git age init`
+3. Add some identities
+  - `git age ident key.txt`
+  - `git age ident ssh`
+4. Set up your config ([example](.git-age.yaml))
+5. Use git like normal.
+
+## Decrypting an existing repository
+
+Similar to initial install, adding identities prior to `init` so that any encrypted files are decrypted during initialization.
+
+1. Install `git-age` in your `PATH`
+2. Clone the repository
+3. Add some identities
+  - `git age ident key.txt`
+  - `git age ident ssh`
+4. `git age init`
+5. Use git like normal
+
 ## License
 
 This software was written based off of [git-agecrypt](https://github.com/vlaci/git-agecrypt/tree/945b80556d8848f6e85a8cc0053f9020bdc8b359).