From ff38b54b00aa90559ccc36d837501e0af228cb64 Mon Sep 17 00:00:00 2001
From: Tom van der Woerdt <info@tvdw.eu>
Date: Sun, 22 Apr 2018 18:49:21 +0200
Subject: [PATCH] Create README.md

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4057fd3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# tnaegap-hss
+ssh-agent proxy for Windows applications that only speak Pageant
+
+The pageant.exe implementation that comes with PuTTY has a very limited implementation of the agent protocol. To work around this, I wrote this small agent which allows Windows applications to use the regular OpenSSH ssh-agent instead of Pageant. This enables the usage of many new ciphersuites, SSH certificates, and more.
+
+## Installation
+
+### From a binary release
+
+(TODO)
+
+### From source
+
+    git clone https://github.com/TvdW/tnaegap-hss
+    cd tnaegap-hss
+    make
+    ./tnaegap-hss &
+
+## What's with the name?
+
+`reverse("ssh-pageant") = "tnaegap-hss"`. @cuviper built the exact inverse of what I needed already, and it's called [ssh-pageant](https://github.com/cuviper/ssh-pageant). 
+
+## License
+
+Gnu Public License (GPL), version 3 or later