From 3245041496f10cf31218bee1c8e31be3f6b61012 Mon Sep 17 00:00:00 2001 From: Tim Byrne Date: Sat, 8 Aug 2020 21:09:13 -0500 Subject: [PATCH] Add documentation for transcrypt --- _docs/080_encryption.md | 17 ++++++++++------- _docs/110_faq.md | 5 +++-- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/_docs/080_encryption.md b/_docs/080_encryption.md index 0e07083..54b0b9a 100644 --- a/_docs/080_encryption.md +++ b/_docs/080_encryption.md @@ -39,13 +39,16 @@ be enabled using the `yadm.gpg-recipient` configuration. To do so, run: For this to work, `` must exist in your gpg keyrings. -## git-crypt +## transcrypt & git-crypt -git-crypt is a tool that enables transparent encryption and decryption of files -in a Git repository. If git-crypt is installed, you can use it with your yadm -repository. +transcrypt & git-crypt are tools that enable transparent encryption and +decryption of files in a Git repository. If installed, you can use either of +these tools with your yadm repository. -Simply use it normally, prefacing the `git-crypt` commands with `yadm`. +Simply use it normally, prefacing the `transcrypt` or `git-crypt` commands with +`yadm`. -You can learn more about [git-crypt](https://github.com/AGWA/git-crypt) at this -[website](https://www.agwa.name/projects/git-crypt/). +Learn more about these tools here: + +* [transcrypt](https://github.com/elasticdog/transcrypt) +* [git-crypt](https://github.com/AGWA/git-crypt) diff --git a/_docs/110_faq.md b/_docs/110_faq.md index b09f88f..d8b3b52 100644 --- a/_docs/110_faq.md +++ b/_docs/110_faq.md @@ -149,9 +149,10 @@ this variable to your shell in your login scripts. export GPG_TTY=$(tty) ``` -### Can I use yadm and git-crypt? +### Can I use yadm with transcrypt or git-crypt? -Yes, yadm now supports git-crypt. Read more [here](/docs/encryption#git-crypt). +Yes, yadm now supports both transcrypt and git-crypt. +Read more [here](/docs/encryption#transcrypt--git-crypt). ## Directory Creation