readme update for release v2.1.0 and godoc update

go-resty · Oct 10, 2019 · de0735f · de0735f
1 parent 7a4c9b3
commit de0735f
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 57 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 <p align="center"><a href="#features">Features</a> section describes in detail about Resty capabilities</p>
 </p>
 <p align="center">
-<p align="center"><a href="https://travis-ci.org/go-resty/resty"><img src="https://travis-ci.org/go-resty/resty.svg?branch=master" alt="Build Status"></a> <a href="https://codecov.io/gh/go-resty/resty/branch/master"><img src="https://codecov.io/gh/go-resty/resty/branch/master/graph/badge.svg" alt="Code Coverage"></a> <a href="https://goreportcard.com/report/go-resty/resty"><img src="https://goreportcard.com/badge/go-resty/resty" alt="Go Report Card"></a> <a href="https://github.com/go-resty/resty/releases/latest"><img src="https://img.shields.io/badge/version-2.0.0-blue.svg" alt="Release Version"></a> <a href="https://godoc.org/github.com/go-resty/resty"><img src="https://godoc.org/github.com/go-resty/resty?status.svg" alt="GoDoc"></a> <a href="LICENSE"><img src="https://img.shields.io/github/license/go-resty/resty.svg" alt="License"></a></p>
+<p align="center"><a href="https://travis-ci.org/go-resty/resty"><img src="https://travis-ci.org/go-resty/resty.svg?branch=master" alt="Build Status"></a> <a href="https://codecov.io/gh/go-resty/resty/branch/master"><img src="https://codecov.io/gh/go-resty/resty/branch/master/graph/badge.svg" alt="Code Coverage"></a> <a href="https://goreportcard.com/report/go-resty/resty"><img src="https://goreportcard.com/badge/go-resty/resty" alt="Go Report Card"></a> <a href="https://github.com/go-resty/resty/releases/latest"><img src="https://img.shields.io/badge/version-2.1.0-blue.svg" alt="Release Version"></a> <a href="https://godoc.org/github.com/go-resty/resty"><img src="https://godoc.org/github.com/go-resty/resty?status.svg" alt="GoDoc"></a> <a href="LICENSE"><img src="https://img.shields.io/github/license/go-resty/resty.svg" alt="License"></a></p>
 </p>
 <p align="center">
 <h4 align="center">Resty Communication Channels</h4>
@@ -13,6 +13,7 @@
 
 ## News
 
+  * v2.1.0 [released](https://github.com/go-resty/resty/releases/tag/v2.1.0) and tagged on Oct 10, 2019.
   * v2.0.0 [released](https://github.com/go-resty/resty/releases/tag/v2.0.0) and tagged on Jul 16, 2019.
   * v1.12.0 [released](https://github.com/go-resty/resty/releases/tag/v1.12.0) and tagged on Feb 27, 2019.  
   * v1.0 released and tagged on Sep 25, 2017. - Resty's first version was released on Sep 15, 2015 then it grew gradually as a very handy and helpful library. Its been a two years since first release. I'm very thankful to Resty users and its [contributors](https://github.com/go-resty/resty/graphs/contributors).
@@ -21,9 +22,10 @@
 
   * GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS, etc.
   * Simple and chainable methods for settings and request
-  * Request Body can be `string`, `[]byte`, `struct`, `map`, `slice` and `io.Reader` too
+  * [Request](https://godoc.org/github.com/go-resty/resty#Request) Body can be `string`, `[]byte`, `struct`, `map`, `slice` and `io.Reader` too
     * Auto detects `Content-Type`
     * Buffer less processing for `io.Reader`
+    * Request Body can be read multiple times via `Request.RawRequest.GetBody()`
   * [Response](https://godoc.org/github.com/go-resty/resty#Response) object gives you more possibility
     * Access as `[]byte` array - `response.Body()` OR Access as `string` - `response.String()`
     * Know your `response.Time()` and when we `response.ReceivedAt()`
@@ -102,7 +104,7 @@ Resty author also published following projects for Go Community.
 
 ```bash
 # Go Modules
-require github.com/go-resty/resty/v2 v2.0.0
+require github.com/go-resty/resty/v2 v2.1.0
 ```
 
 ## Usage
@@ -153,14 +155,14 @@ Error      : <nil>
 Status Code: 200
 Status     : 200 OK
 Time       : 465.301137ms
-Received At: 2019-03-10 01:52:33.772456 -0800 PST m=+0.466672260
+Received At: 2019-06-16 01:52:33.772456 -0800 PST m=+0.466672260
 Body       :
  {
   "args": {},
   "headers": {
     "Accept-Encoding": "gzip",
     "Host": "httpbin.org",
-    "User-Agent": "go-resty/2.0.0-rc.1 (https://github.com/go-resty/resty)"
+    "User-Agent": "go-resty/2.0.0 (https://github.com/go-resty/resty)"
   },
   "origin": "0.0.0.0",
   "url": "https://httpbin.org/get"

diff --git a/client.go b/client.go
@@ -185,11 +185,6 @@ func (c *Client) SetCookieJar(jar http.CookieJar) *Client {
 // 		client.SetCookie(&http.Cookie{
 // 					Name:"go-resty",
 //					Value:"This is cookie value",
-//					Path: "/",
-// 					Domain: "sample.com",
-// 					MaxAge: 36000,
-// 					HttpOnly: true,
-//					Secure: false,
 // 				})
 func (c *Client) SetCookie(hc *http.Cookie) *Client {
 	c.Cookies = append(c.Cookies, hc)
@@ -198,27 +193,16 @@ func (c *Client) SetCookie(hc *http.Cookie) *Client {
 
 // SetCookies method sets an array of cookies in the client instance.
 // These cookies will be added to all the request raised from this client instance.
-// 		cookies := make([]*http.Cookie, 0)
-//
-//		cookies = append(cookies, &http.Cookie{
-// 					Name:"go-resty-1",
-// 					Value:"This is cookie 1 value",
-// 					Path: "/",
-// 					Domain: "sample.com",
-// 					MaxAge: 36000,
-// 					HttpOnly: true,
-//					Secure: false,
-// 				})
-//
-//		cookies = append(cookies, &http.Cookie{
-// 					Name:"go-resty-2",
-// 					Value:"This is cookie 2 value",
-// 					Path: "/",
-// 					Domain: "sample.com",
-// 					MaxAge: 36000,
-// 					HttpOnly: true,
-//					Secure: false,
-// 				})
+// 		cookies := []*http.Cookie{
+// 			&http.Cookie{
+// 				Name:"go-resty-1",
+// 				Value:"This is cookie 1 value",
+// 			},
+// 			&http.Cookie{
+// 				Name:"go-resty-2",
+// 				Value:"This is cookie 2 value",
+// 			},
+// 		}
 //
 //		// Setting a cookies into resty
 // 		client.SetCookies(cookies)

diff --git a/request.go b/request.go
@@ -470,11 +470,6 @@ func (r *Request) SetJSONEscapeHTML(b bool) *Request {
 // 		client.R().SetCookie(&http.Cookie{
 // 					Name:"go-resty",
 // 					Value:"This is cookie value",
-// 					Path: "/",
-// 					Domain: "sample.com",
-// 					MaxAge: 36000,
-// 					HttpOnly: true,
-//					Secure: false,
 // 				})
 //
 // Note: Method appends the Cookie value into existing Cookie if already existing.
@@ -486,27 +481,16 @@ func (r *Request) SetCookie(hc *http.Cookie) *Request {
 }
 
 // SetCookies method sets an array of cookies in the current request instance.
-// 		cookies := make([]*http.Cookie, 0)
-//
-//		cookies = append(cookies, &http.Cookie{
-// 					Name:"go-resty-1",
-// 					Value:"This is cookie 1 value",
-// 					Path: "/",
-// 					Domain: "sample.com",
-// 					MaxAge: 36000,
-// 					HttpOnly: true,
-//					Secure: false,
-// 				})
-//
-//		cookies = append(cookies, &http.Cookie{
-// 					Name:"go-resty-2",
-// 					Value:"This is cookie 2 value",
-// 					Path: "/",
-// 					Domain: "sample.com",
-// 					MaxAge: 36000,
-// 					HttpOnly: true,
-//					Secure: false,
-// 				})
+// 		cookies := []*http.Cookie{
+// 			&http.Cookie{
+// 				Name:"go-resty-1",
+// 				Value:"This is cookie 1 value",
+// 			},
+// 			&http.Cookie{
+// 				Name:"go-resty-2",
+// 				Value:"This is cookie 2 value",
+// 			},
+// 		}
 //
 //		// Setting a cookies into resty's current request
 // 		client.R().SetCookies(cookies)