Update README (A git remote helper for GPG-encrypted remotes)

diff --git a/README b/README
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..009f9b25899f2954bd6d6a9c7d141089959e1a04 100644 (file)
--- a/README
+++ b/README
@@ -0,0 +1,18 @@
+
+    # git-remote-gcrypt
+    # Copyright 2013  by Ulrik
+    # License: GPLv2 or any later version, see http://www.gnu.org/licenses/
+    #
+    # Requires GnuPG
+    #
+    # We read git config gcrypt.recipients when creating new repositories
+
+Install as git-remote-gcrypt in $PATH
+
+Supports local, ssh:// and sftp:// remotes at the moment.
+
+    git config --global gcrypt.recipients KEYID1
+    git remote add gcryptrepo gcrypt::ssh://hostname.com:MyRepo.git
+
+WARNING: This is a proof of concept
+WARNING: Repository format WILL change, incompatibly