summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--README.legacy (renamed from README)0
-rw-r--r--README.md16
2 files changed, 16 insertions, 0 deletions
diff --git a/README b/README.legacy
index 03ea1a75..03ea1a75 100644
--- a/README
+++ b/README.legacy
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..35960440
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# ssh
+
+The `ssh` library is a fork of, and spiritual successor to, the
+[Paramiko](http://www.lag.net/paramiko/) Python SSH library. It was created by
+the developers of the [Fabric](http://fabfile.org) library as a way to ensure
+timely updates and bugfixes for critical issues.
+
+`ssh` is currently in a transitional state and other than a rename and a
+handful of small but crucial source changes, the code and the documentation
+remain unchanged from the original.
+
+We hope to clean up the presentation and documentation in the near future, as
+more bugfixes and API additions are rolled out. We also plan to absorb some of
+the higher profile bugs/issues from the Paramiko Github repository as well.
+
+Thank you for your patience!