brouzouf/ftp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rework README

Browse Source 
Add a badge link to godoc.org
Add a small code example
This commit is contained in:
Julien Laffaye 2019-04-10 20:28:22 +02:00
parent 04b1878733
commit 73b56eeee6
1 changed files with 19 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -3,6 +3,7 @@
[![Build Status](https://travis-ci.org/jlaffaye/ftp.svg?branch=master)](https://travis-ci.org/jlaffaye/ftp) [![Build Status](https://travis-ci.org/jlaffaye/ftp.svg?branch=master)](https://travis-ci.org/jlaffaye/ftp)
[![Coverage Status](https://coveralls.io/repos/jlaffaye/ftp/badge.svg?branch=master&service=github)](https://coveralls.io/github/jlaffaye/ftp?branch=master) [![Coverage Status](https://coveralls.io/repos/jlaffaye/ftp/badge.svg?branch=master&service=github)](https://coveralls.io/github/jlaffaye/ftp?branch=master)
[![Go ReportCard](http://goreportcard.com/badge/jlaffaye/ftp)](http://goreportcard.com/report/jlaffaye/ftp) [![Go ReportCard](http://goreportcard.com/badge/jlaffaye/ftp)](http://goreportcard.com/report/jlaffaye/ftp)
[![godoc.org](https://godoc.org/github.com/jlaffaye/ftp?status.svg)](http://godoc.org/github.com/jlaffaye/ftp)
A FTP client package for Go A FTP client package for Go
@ -12,6 +13,22 @@ A FTP client package for Go
go get -u github.com/jlaffaye/ftp go get -u github.com/jlaffaye/ftp
``` ```
## Documentation ## ## Example ##
http://godoc.org/github.com/jlaffaye/ftp ```go
c, err := ftp.DialWithOptions("ftp.example.org", DialWithTimeout(5*time.Second))
if err != nil {
t.Fatal(err)
}
err = c.Login("anonymous", "anonymous")
if err != nil {
t.Fatal(err)
}
// Do something with the FTP conn
if err := c.Close(); err != nil {
t.Fatal(err)
}
```