Skip to content

Commit

Permalink
v0.10 release readme update
Browse files Browse the repository at this point in the history
[ci skip]
  • Loading branch information
jeevatkm committed Jan 2, 2017
1 parent 7e4e1bc commit 2e0c231
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,12 @@

Simple HTTP and REST client for Go inspired by Ruby rest-client. [Features](#features) section describes in detail about resty capabilities.

***v0.9 [released](https://github.com/go-resty/resty/releases/latest) and tagged on Nov 01, 2016.***
***v0.10 [released](https://github.com/go-resty/resty/releases/latest) and tagged on Jan 02, 2017.***

*Since Go v1.6 HTTP/2 & HTTP/1.1 protocol is used transparently. `Resty` works fine with HTTP/2 and HTTP/1.1.*

#### Roadmap
***v0.10***

I will be focusing on golint, etc. code quality improvements (may have very minor breaking change due to golint)

***v1.0 (Around New Year)***
***v1.0***

Go Resty first released on Sep 15, 2015 then go-resty grew gradually as a very handy and helpful library of HTTP & REST Client in the golang community. I'm planning to freeze API and make v1.0 release.

Expand All @@ -27,7 +23,8 @@ Go Resty first released on Sep 15, 2015 then go-resty grew gradually as a very h
* Default is `JSON`, if you supply `struct/map` without header `Content-Type`
* Easy to upload one or more file(s) via `multipart/form-data`
* Backoff Retry Mechanism with retry condition function [reference](retry_test.go)
* resty client [Request](https://godoc.org/github.com/go-resty/resty#Client.OnBeforeRequest) and [Response](https://godoc.org/github.com/go-resty/resty#Client.OnAfterResponse) middlewares
* resty client HTTP & REST [Request](https://godoc.org/github.com/go-resty/resty#Client.OnBeforeRequest) and [Response](https://godoc.org/github.com/go-resty/resty#Client.OnAfterResponse) middlewares
* `Request.SetContext` supported `go1.7` and above
* Authorization option of `BasicAuth` and `Bearer` token
* Set request `ContentLength` value for all request or particular request
* Choose between HTTP and REST mode. Default is `REST`
Expand All @@ -37,10 +34,12 @@ Go Resty first released on Sep 15, 2015 then go-resty grew gradually as a very h
* Download/Save HTTP response directly into File, like `curl -o` flag. See [SetOutputDirectory](https://godoc.org/github.com/go-resty/resty#Client.SetOutputDirectory) & [SetOutput](https://godoc.org/github.com/go-resty/resty#Request.SetOutput).
* Cookies for your request and CookieJar support
* Client settings like `Timeout`, `RedirectPolicy`, `Proxy`, `TLSClientConfig`, `Transport`, etc.
* Client API design
* resty design
* Have client level settings & options and also override at Request level if you want to
* Request and Response middlewares
* Create Multiple clients if want to `resty.New()`
* goroutine concurrent safe
* REST and HTTP modes
* Debug mode - clean and informative logging presentation
* Gzip - I'm not doing anything here. Go does it automatically
* Well tested client library
Expand All @@ -53,7 +52,9 @@ resty tested with Go `v1.2` and above.
* FlexibleRedirectPolicy
* DomainCheckRedirectPolicy
* etc. [more info](redirect.go)
* Backoff Retry Mechanism with retry condition function [reference](retry_test.go)
* Retry Mechanism [reference](retry_test.go)
* Backoff Retry
* Conditional Retry
* etc (upcoming - throw your idea's [here](https://github.com/go-resty/resty/issues)).

## Installation
Expand Down

0 comments on commit 2e0c231

Please sign in to comment.