Skip to content

Commit efead03

Browse files
authored
Adds suggestions on how to upgrade to v1.0 in README.md (#1105)
1 parent e8a6662 commit efead03

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,17 @@ Rack::Test, and a Test adapter for stubbing requests by hand.
3131

3232
Available at [rubydoc.info](http://www.rubydoc.info/gems/faraday).
3333

34+
## Faraday 1.0
35+
36+
Faraday 1.0 will ship soon! Faraday 0.17 will be the last 0.x release, except for serious bugs or security issues.
37+
Faraday 1.0 is a major release, but it will be mostly backwards-compatible with 0.x, so we strongly encourage you
38+
to use it on your next projects and/or consider to upgrade your existing ones.
39+
Upgrading is simple:
40+
41+
* Checkout the new code from [`master`](https://github.com/lostisland/faraday) and the new [Documentation Website](https://lostisland.github.io/faraday/).
42+
* If you're upgrading an existing project, check the [UPGRADING](https://github.com/lostisland/faraday/blob/master/UPGRADING.md) file.
43+
* You can also enable upgrade warnings on apps with Faraday 0.x if you run them with `FARADAY_DEPRECATE=warn` or `FARADAY_DEPRECATE=1` in ENV.
44+
3445
## Usage
3546

3647
### Basic Use

0 commit comments

Comments
 (0)