From aa125e1bc1435e2661f95a783c66bd5fee523bdc Mon Sep 17 00:00:00 2001 From: rick olson Date: Wed, 3 Apr 2019 09:53:53 -0600 Subject: [PATCH] add em adapter docs --- README.md | 4 ++-- docs/adapters/em-http.md | 21 +++++++++++++++++++++ docs/adapters/em-synchrony.md | 21 +++++++++++++++++++++ 3 files changed, 44 insertions(+), 2 deletions(-) create mode 100644 docs/adapters/em-http.md create mode 100644 docs/adapters/em-synchrony.md diff --git a/README.md b/README.md index dec40fba..2dd38d13 100644 --- a/README.md +++ b/README.md @@ -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/ diff --git a/docs/adapters/em-http.md b/docs/adapters/em-http.md new file mode 100644 index 00000000..d994bd4a --- /dev/null +++ b/docs/adapters/em-http.md @@ -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 diff --git a/docs/adapters/em-synchrony.md b/docs/adapters/em-synchrony.md new file mode 100644 index 00000000..8184ae6a --- /dev/null +++ b/docs/adapters/em-synchrony.md @@ -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