aboutsummaryrefslogtreecommitdiff
path: root/vendor/github.com/pkg/sftp/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/pkg/sftp/README.md')
-rw-r--r--vendor/github.com/pkg/sftp/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/vendor/github.com/pkg/sftp/README.md b/vendor/github.com/pkg/sftp/README.md
new file mode 100644
index 0000000..e406b1e
--- /dev/null
+++ b/vendor/github.com/pkg/sftp/README.md
@@ -0,0 +1,27 @@
+sftp
+----
+
+The `sftp` package provides support for file system operations on remote ssh servers using the SFTP subsystem.
+
+[![UNIX Build Status](https://travis-ci.org/pkg/sftp.svg?branch=master)](https://travis-ci.org/pkg/sftp) [![GoDoc](http://godoc.org/github.com/pkg/sftp?status.svg)](http://godoc.org/github.com/pkg/sftp)
+
+usage and examples
+------------------
+
+See [godoc.org/github.com/pkg/sftp](http://godoc.org/github.com/pkg/sftp) for examples and usage.
+
+The basic operation of the package mirrors the facilities of the [os](http://golang.org/pkg/os) package.
+
+The Walker interface for directory traversal is heavily inspired by Keith Rarick's [fs](http://godoc.org/github.com/kr/fs) package.
+
+roadmap
+-------
+
+ * There is way too much duplication in the Client methods. If there was an unmarshal(interface{}) method this would reduce a heap of the duplication.
+
+contributing
+------------
+
+We welcome pull requests, bug fixes and issue reports.
+
+Before proposing a large change, first please discuss your change by raising an issue.