Skip to content

Commit

Permalink
Move documentation from Faraday website to README
Browse files Browse the repository at this point in the history
  • Loading branch information
iMacTia committed Dec 29, 2021
1 parent 0f1d8a2 commit 645f368
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Expand Up @@ -22,16 +22,16 @@ Or install them yourself as:

## Usage

Configure your Faraday connection to use this adapter like this:

```ruby
connection = Faraday.new(url, conn_options) do |conn|
conn.adapter(:httpclient)
conn = Faraday.new(...) do |f|
f.adapter :httpclient do |client|
# yields HTTPClient
client.keep_alive_timeout = 20
client.ssl_config.timeout = 25
end
end
```

For more information on how to setup your Faraday connection and adapters usage, please refer to the [Faraday Website][faraday-website].

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
Expand All @@ -51,7 +51,6 @@ The gem is available as open source under the terms of the [license][license].
Everyone interacting in the Faraday HTTPClient adapter project's codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct][code-of-conduct].

[faraday]: https://github.com/lostisland/faraday
[faraday-website]: https://lostisland.github.io/faraday
[httpclient]: https://github.com/nahi/httpclient
[rubygems]: https://rubygems.org
[repo]: https://github.com/lostisland/faraday-httpclient
Expand Down

0 comments on commit 645f368

Please sign in to comment.