浏览代码

Rework README

Add a badge link to godoc.org
Add a small code example
Julien Laffaye 6 年之前
父节点
当前提交
73b56eeee6
共有 1 个文件被更改,包括 19 次插入2 次删除
  1. 19 2
      README.md

+ 19 - 2
README.md

@@ -3,6 +3,7 @@
 [![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)
 [![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
 
@@ -12,6 +13,22 @@ A FTP client package for Go
 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)
+}
+```