From e41ab9194a500b27b472f108181839ed26a55606 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 27 Feb 2012 22:39:15 -0800 Subject: [PATCH] First draft of modern explanatory README (cherry picked from commit 4f7338bbfc5f2f157208b6343bf215cff4db126b) --- README => README.legacy | 0 README.md | 16 ++++++++++++++++ 2 files changed, 16 insertions(+) rename README => README.legacy (100%) create mode 100644 README.md diff --git a/README b/README.legacy similarity index 100% rename from README rename to README.legacy diff --git a/README.md b/README.md new file mode 100644 index 0000000..3596044 --- /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!