From 73b56eeee68d81afb4e5a81e20a67b987aef1c78 Mon Sep 17 00:00:00 2001
From: Julien Laffaye <jlaffaye@FreeBSD.org>
Date: Wed, 10 Apr 2019 20:28:22 +0200
Subject: [PATCH] Rework README

Add a badge link to godoc.org
Add a small code example
---
 README.md | 21 +++++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index b711be7..0ef7d68 100644
--- a/README.md
+++ b/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)
+}
+```