Skip to content

Commit 645f368

Browse files
authored
Move documentation from Faraday website to README
1 parent 0f1d8a2 commit 645f368

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,16 @@ Or install them yourself as:
2222

2323
## Usage
2424

25-
Configure your Faraday connection to use this adapter like this:
26-
2725
```ruby
28-
connection = Faraday.new(url, conn_options) do |conn|
29-
conn.adapter(:httpclient)
26+
conn = Faraday.new(...) do |f|
27+
f.adapter :httpclient do |client|
28+
# yields HTTPClient
29+
client.keep_alive_timeout = 20
30+
client.ssl_config.timeout = 25
31+
end
3032
end
3133
```
3234

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

3737
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.
@@ -51,7 +51,6 @@ The gem is available as open source under the terms of the [license][license].
5151
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].
5252

5353
[faraday]: https://github.com/lostisland/faraday
54-
[faraday-website]: https://lostisland.github.io/faraday
5554
[httpclient]: https://github.com/nahi/httpclient
5655
[rubygems]: https://rubygems.org
5756
[repo]: https://github.com/lostisland/faraday-httpclient

0 commit comments

Comments
 (0)