add em adapter docs

This commit is contained in:
rick olson 2019-04-03 09:53:53 -06:00
parent 39058484d4
commit aa125e1bc1
3 changed files with 44 additions and 2 deletions

View File

@ -17,7 +17,7 @@ Faraday supports these adapters out of the box:
* [Net::HTTP::Persistent][persistent]
* [Excon][excon]
* [Patron][patron]
* [EventMachine][eventmachine]
* [EM-Synchrony][em-synchrony]
* [HTTPClient][httpclient]
Adapters are slowly being moved into their own gems, or bundled with HTTP clients.
@ -361,7 +361,7 @@ See [LICENSE][] for details.
[travis]: https://travis-ci.org/lostisland/faraday
[excon]: ./docs/adapters/excon.md
[patron]: ./docs/adapters/patron.md
[eventmachine]: https://github.com/igrigorik/em-http-request#readme
[em-synchrony]: ./docs/adapters/em-synchrony.md
[httpclient]: ./docs/adapters/httpclient.md
[typhoeus]: https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/adapters/faraday.rb
[jruby]: http://jruby.org/

21
docs/adapters/em-http.md Normal file
View File

@ -0,0 +1,21 @@
# EM-HTTP Adapter
This Adapter uses the [em-http-request][rdoc] gem to make HTTP requests.
```ruby
conn = Faraday.new(...) do |f|
# no custom options available
f.adapter :em_http
end
```
## Links
* [Gem RDoc][rdoc]
* [Gem source][src]
* [Adapter RDoc][adapter_rdoc]
* [EM-HTTP Adapter](./em-http.md)
[rdoc]: https://www.rubydoc.info/gems/em-http-request
[src]: https://github.com/igrigorik/em-http-request#readme
[adapter_rdoc]: https://www.rubydoc.info/gems/faraday/Faraday/Adapter/EMHttp

View File

@ -0,0 +1,21 @@
# EM-Synchrony Adapter
This Adapter uses the [em-synchrony][rdoc] gem to make HTTP requests.
```ruby
conn = Faraday.new(...) do |f|
# no custom options available
f.adapter :em_synchrony
end
```
## Links
* [Gem RDoc][rdoc]
* [Gem source][src]
* [Adapter RDoc][adapter_rdoc]
* [EM-HTTP Adapter](./em-http.md)
[rdoc]: https://www.rubydoc.info/gems/em-synchrony
[src]: https://github.com/igrigorik/em-synchrony
[adapter_rdoc]: https://www.rubydoc.info/gems/faraday/Faraday/Adapter/EMSynchrony