Skip to content

Commit

Permalink
Update README usage and remove v2.0 warning
Browse files Browse the repository at this point in the history
  • Loading branch information
iMacTia committed Jan 4, 2022
1 parent 2b6fb04 commit c75df72
Showing 1 changed file with 3 additions and 11 deletions.
14 changes: 3 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,12 @@

This gem is a [Faraday][faraday] adapter for the [Net::HTTP::Persistent gem][net-http-persistent].

---

:warning: **This README is for the `main` branch that uses Faraday 2.0, which is not yet released.**

For 1.0-compatible documentation, refer to [v1.2.0 of the README](https://github.com/lostisland/faraday-net_http_persistent/blob/v1.2.0/README.md).

---

## Installation

Add this to your application's Gemfile:

```ruby
gem 'faraday-net_http_persistent',
git: 'https://github.com/lostisland/faraday-net_http_persistent',
branch: 'main'
gem 'faraday-net_http_persistent', '~> 2.0'
```

And then execute:
Expand All @@ -30,6 +20,8 @@ And then execute:
## Usage

```ruby
require 'faraday/net_http_persistent'

conn = Faraday.new(...) do |f|
f.adapter :net_http_persistent, pool_size: 5 do |http|
# yields Net::HTTP::Persistent
Expand Down

0 comments on commit c75df72

Please sign in to comment.