Skip to content

Commit d0ceb87

Browse files
committed
version promoted to v1.0 and readme update
1 parent f8e1383 commit d0ceb87

File tree

2 files changed

+17
-21
lines changed

2 files changed

+17
-21
lines changed

README.md

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
1-
# resty [![Build Status](https://travis-ci.org/go-resty/resty.svg?branch=master)](https://travis-ci.org/go-resty/resty) [![codecov](https://codecov.io/gh/go-resty/resty/branch/master/graph/badge.svg)](https://codecov.io/gh/go-resty/resty/branch/master) [![GoReport](https://goreportcard.com/badge/go-resty/resty)](https://goreportcard.com/report/go-resty/resty) [![Version](https://img.shields.io/badge/version-0.13-blue.svg)](https://github.com/go-resty/resty/releases/latest) [![GoDoc](https://godoc.org/github.com/go-resty/resty?status.svg)](https://godoc.org/github.com/go-resty/resty) [![License](https://img.shields.io/github/license/go-resty/resty.svg)](LICENSE)
1+
# Resty [![Build Status](https://travis-ci.org/go-resty/resty.svg?branch=master)](https://travis-ci.org/go-resty/resty) [![codecov](https://codecov.io/gh/go-resty/resty/branch/master/graph/badge.svg)](https://codecov.io/gh/go-resty/resty/branch/master) [![GoReport](https://goreportcard.com/badge/go-resty/resty)](https://goreportcard.com/report/go-resty/resty) [![Version](https://img.shields.io/badge/version-1.0-blue.svg)](https://github.com/go-resty/resty/releases/latest) [![GoDoc](https://godoc.org/github.com/go-resty/resty?status.svg)](https://godoc.org/github.com/go-resty/resty) [![License](https://img.shields.io/github/license/go-resty/resty.svg)](LICENSE)
22

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

5-
***v0.13 [released](https://github.com/go-resty/resty/releases/latest) and tagged on Jun 22, 2017.***
5+
***v1.0 [released](https://github.com/go-resty/resty/releases/latest) and tagged on Sep 25, 2017.***
66

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

9-
#### Roadmap
10-
***v1.0***
9+
#### v1.0 Released
1110

12-
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.
11+
Resty first version released on Sep 15, 2015 then it grew gradually as a very handy and helpful library. Its been a two year; `v1.0` released on Sep 25, 2017. I'm very thankful to Resty users and its [contributors](https://github.com/go-resty/resty/graphs/contributors).
1312

1413
#### Features
1514
* GET, POST, PUT, DELETE, HEAD, PATCH and OPTIONS
@@ -22,8 +21,8 @@ Go Resty first released on Sep 15, 2015 then go-resty grew gradually as a very h
2221
* Automatic marshal and unmarshal for `JSON` and `XML` content type
2322
* Default is `JSON`, if you supply `struct/map` without header `Content-Type`
2423
* For auto-unmarshal, refer to -
25-
- Success scenario [Request.SetResult()](https://godoc.org/gopkg.in/resty.v0#Request.SetResult) and [Response.Result()](https://godoc.org/gopkg.in/resty.v0#Response.Result).
26-
- Error scenario [Request.SetError()](https://godoc.org/gopkg.in/resty.v0#Request.SetError) and [Response.Error()](https://godoc.org/gopkg.in/resty.v0#Response.Error).
24+
- Success scenario [Request.SetResult()](https://godoc.org/github.com/go-resty/resty#Request.SetResult) and [Response.Result()](https://godoc.org/github.com/go-resty/resty#Response.Result).
25+
- Error scenario [Request.SetError()](https://godoc.org/github.com/go-resty/resty#Request.SetError) and [Response.Error()](https://godoc.org/github.com/go-resty/resty#Response.Error).
2726
* Easy to upload one or more file(s) via `multipart/form-data`
2827
* Backoff Retry Mechanism with retry condition function [reference](retry_test.go)
2928
* 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
@@ -41,8 +40,8 @@ Go Resty first released on Sep 15, 2015 then go-resty grew gradually as a very h
4140
* Optionally allows GET request with payload, see [SetAllowGetMethodPayload](https://godoc.org/github.com/go-resty/resty#Client.SetAllowGetMethodPayload)
4241
* Supports registering external JSON library into resty, see [how to use](https://github.com/go-resty/resty/issues/76#issuecomment-314015250)
4342
* Exposes Response reader without reading response (no auto-unmarshaling) if need be, see [how to use](https://github.com/go-resty/resty/issues/87#issuecomment-322100604)
44-
* Option to specify expected `Content-Type` when response `Content-Type` header missing. Refer [#92](https://github.com/go-resty/resty/issues/92)
45-
* resty design
43+
* Option to specify expected `Content-Type` when response `Content-Type` header missing. Refer to [#92](https://github.com/go-resty/resty/issues/92)
44+
* Resty design
4645
* Have client level settings & options and also override at Request level if you want to
4746
* Request and Response middlewares
4847
* Create Multiple clients if you want to `resty.New()`
@@ -72,7 +71,7 @@ resty tested with Go `v1.3` and above.
7271
Please refer section [Versioning](#versioning) for detailed info.
7372
```sh
7473
# install the library
75-
go get -u gopkg.in/resty.v0
74+
go get -u gopkg.in/resty.v1
7675
```
7776
#### Latest Version - Development Edge
7877
```sh
@@ -92,9 +91,7 @@ The following samples will assist you to become as comfortable as possible with
9291

9392
Import resty into your code and refer it as `resty`.
9493
```go
95-
import (
96-
"gopkg.in/resty.v0"
97-
)
94+
import "gopkg.in/resty.v1"
9895
```
9996

10097
#### Simple GET
@@ -107,7 +104,7 @@ fmt.Printf("\nError: %v", err)
107104
fmt.Printf("\nResponse Status Code: %v", resp.StatusCode())
108105
fmt.Printf("\nResponse Status: %v", resp.Status())
109106
fmt.Printf("\nResponse Time: %v", resp.Time())
110-
fmt.Printf("\nResponse Recevied At: %v", resp.ReceivedAt())
107+
fmt.Printf("\nResponse Received At: %v", resp.ReceivedAt())
111108
fmt.Printf("\nResponse Body: %v", resp) // or resp.String() or string(resp.Body())
112109
// more...
113110

@@ -116,7 +113,7 @@ Error: <nil>
116113
Response Status Code: 200
117114
Response Status: 200 OK
118115
Response Time: 644.290186ms
119-
Response Recevied At: 2015-09-15 12:05:28.922780103 -0700 PDT
116+
Response Received At: 2015-09-15 12:05:28.922780103 -0700 PDT
120117
Response Body: {
121118
"args": {},
122119
"headers": {
@@ -636,17 +633,16 @@ resty releases versions according to [Semantic Versioning](http://semver.org)
636633

637634
`gopkg.in/resty.vX` points to appropriate tag versions; `X` denotes version number and it's a stable release. It's recommended to use version, for eg. `gopkg.in/resty.v0`. Development takes place at the master branch. Although the code in master should always compile and test successfully, it might break API's. We aim to maintain backwards compatibility, but API's and behaviour might be changed to fix a bug.
638635

639-
640636
## Contributing
641637
Welcome! If you find any improvement or issue you want to fix, feel free to send a pull request, I like pull requests that include test cases for fix/enhancement. I have done my best to bring pretty good code coverage. Feel free to write tests.
642638

643-
BTW, I'd like to know what you think about go-resty. Kindly open an issue or send me an email; it'd mean a lot to me.
639+
BTW, I'd like to know what you think about `Resty`. Kindly open an issue or send me an email; it'd mean a lot to me.
644640

645641
## Author
646-
Jeevanandam M. - jeeva@myjeeva.com
642+
[Jeevanandam M.](https://github.com/jeevatkm) (jeeva@myjeeva.com)
647643

648644
## Contributors
649645
Have a look on [Contributors](https://github.com/go-resty/resty/graphs/contributors) page.
650646

651647
## License
652-
resty released under MIT license, refer [LICENSE](LICENSE) file.
648+
Resty released under MIT license, refer [LICENSE](LICENSE) file.

resty.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66
package resty
77

88
// Version # of resty
9-
const Version = "1.0-dev"
9+
const Version = "1.0"

0 commit comments

Comments
 (0)