Skip to content

Commit

Permalink
refinements to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tisba authored Oct 29, 2024
1 parent c77aef6 commit 5d5c548
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@
[![Gem](https://img.shields.io/gem/v/faraday-follow_redirects.svg?style=flat-square)](https://rubygems.org/gems/faraday-follow_redirects)
[![License](https://img.shields.io/github/license/tisba/faraday-follow-redirects.svg?style=flat-square)](LICENSE.md)

[Faraday](https://github.com/lostisland/faraday) 2.x compatible extraction of `FaradayMiddleware::FollowRedirects`. This gem will also work with Faraday 1.x, to support gem codebases which can work with Faraday 1.x or 2.x. For the former standard version of this middleware for Faraday 1.x, check out <https://github.com/lostisland/faraday_middleware>. Faraday 1.x support is considered deprecated, please update to Faraday 2.x.
[Faraday](https://github.com/lostisland/faraday) middleware to follow HTTP redirects transparently.

This gem is based on the deprecated [`FaradayMiddleware::FollowRedirects` (v1.2.0)](https://github.com/lostisland/faraday_middleware/blob/v1.2.0/lib/faraday_middleware/response/follow_redirects.rb).

We only support non-EOL versions of Ruby. See [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/) for the list of non-EOL Rubies.
> [!IMPORTANT]
> This is a Faraday 2.x compatible extraction of the deprecated [`FaradayMiddleware::FollowRedirects` (v1.2.0)](https://github.com/lostisland/faraday_middleware/blob/v1.2.0/lib/faraday_middleware/response/follow_redirects.rb). This gem will also work with Faraday 1.x on a > best-effort basis. **Faraday 1.x support is considered deprecated, please update to Faraday 2.x as soon as possible!**
>
> We only support non-EOL versions of Ruby. See [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/) for the list of non-EOL Rubies.
## Installation

Expand Down Expand Up @@ -74,7 +75,7 @@ bundle exec appraisal faraday_2 rspec

## Contributing

Bug reports and pull requests are welcome on [GitHub](https://github.com/tisba/faraday-follow_redirects).
Bug reports and pull requests are welcome on [GitHub](https://github.com/tisba/faraday-follow-redirects).

## License

Expand Down

0 comments on commit 5d5c548

Please sign in to comment.