sftp/README.md

43 lines
1.5 KiB
Markdown
Raw Normal View History

2013-11-06 08:16:36 +08:00
sftp
----
2017-01-07 09:22:54 +08:00
The `sftp` package provides support for file system operations on remote ssh
servers using the SFTP subsystem. It also implements an SFTP server for serving
files from the filesystem.
2013-11-06 08:16:36 +08:00
[![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)
2013-11-06 12:54:37 +08:00
2013-11-06 08:16:36 +08:00
usage and examples
------------------
2017-01-07 09:22:54 +08:00
See [godoc.org/github.com/pkg/sftp](http://godoc.org/github.com/pkg/sftp) for
examples and usage.
2013-11-06 08:16:36 +08:00
2017-01-07 09:22:54 +08:00
The basic operation of the package mirrors the facilities of the
[os](http://golang.org/pkg/os) package.
2013-11-06 08:21:57 +08:00
2017-01-07 09:22:54 +08:00
The Walker interface for directory traversal is heavily inspired by Keith
Rarick's [fs](http://godoc.org/github.com/kr/fs) package.
2013-11-06 09:47:49 +08:00
roadmap
-------
2017-01-07 09:22:54 +08:00
* 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.
2013-11-06 09:47:49 +08:00
contributing
------------
2015-12-22 12:00:44 +08:00
We welcome pull requests, bug fixes and issue reports.
2017-01-07 09:25:10 +08:00
Before proposing a large change, first please discuss your change by raising an
issue.
For API/code bugs, please include a small code example to reproduce the issue.
For pull requests, remember test coverage.
We handle issues and pull requests with a 0 open philosophy. That means we will
try to address the submission as soon as possible and will work toward a
resolution. If progress can no longer be made (eg. unreproducible bug) or stops
(eg. unresponsive submitter), we will close the bug.