Doc: upgrading from faraday 1 (#8)

Co-authored-by: Sebastian Cohnen <[email protected]>
tisba · Jan 20, 2024 · 296328e · 296328e
1 parent 2e52bfd
commit 296328e
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -41,6 +41,15 @@ Faraday.new(url: url) do |faraday|
 end
 ```
 
+## Upgrading from Faraday 1.x
+
+If you still use Faraday 1.x, and have uninstalled the `faraday_middleware` gem, all you have to change is:
+
+```diff
+- conn.use FaradayMiddleware::FollowRedirects
++ conn.use Faraday::FollowRedirects::Middleware
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.