diff --git a/README.md b/README.md index f3ed2f2..66ddc38 100644 --- a/README.md +++ b/README.md @@ -13,19 +13,22 @@ which served as a starting point. # Installation -1. **Before using GitCrypt the first time, register the filters:** +1. Before using GitCrypt the first time, register the filters: git config --global filter.gitcrypt.smudge .gitcrypt/dec git config --global filter.gitcrypt.clean .gitcrypt/enc git config --global diff.gitcrypt.textconv .gitcrypt/diff - If this step is omitted, files get added unencrypted silently. + **If this step is omitted, files get added unencrypted silently.** However, it is not needed, if GitCrypt has been used before. 2. Imagine a repository password. It is either expected in the environment variable `$GITCRYPT_PASS`, or in the file `.git/pass` (which is ignored by Git). + **Hint:** You can enter the password safely by using the command: + `read -s GITCRYPT_PASS` + 3. After that, generate a salt: .gitcrypt/gensalt