diff options
| author | Jeff Forcier <jeff@bitprophet.org> | 2012-02-27 22:39:15 -0800 |
|---|---|---|
| committer | Jeff Forcier <jeff@bitprophet.org> | 2012-09-23 16:18:26 -0700 |
| commit | e41ab9194a500b27b472f108181839ed26a55606 (patch) | |
| tree | 3c91213b1e2a7b2f8daae3866310df80fbb4bcd0 | |
| parent | e375d671a446e3352c908454995193f638de7bc5 (diff) | |
| download | paramiko-e41ab9194a500b27b472f108181839ed26a55606.tar.gz | |
First draft of modern explanatory README
(cherry picked from commit 4f7338bbfc5f2f157208b6343bf215cff4db126b)
| -rw-r--r-- | README.legacy (renamed from README) | 0 | ||||
| -rw-r--r-- | README.md | 16 |
2 files changed, 16 insertions, 0 deletions
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! |