Skip to content

Commit 878c935

Browse files
committed
[DOCS] Adds Typhoeus back with note for using 1.4
1 parent 7e0dc9a commit 878c935

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Both of these libraries are extensively documented.
7777
and the [`elasticsearch-api`](http://rubydoc.info/gems/elasticsearch-api) documentation carefully.**
7878

7979
_Keep in mind, that for optimal performance, you should use a HTTP library which supports persistent
80-
("keep-alive") connections, e.g. [Patron](https://github.com/toland/patron)._ These libraries are not dependencies of the elasticsearch gems, so be sure to define a dependency in your own application.
80+
("keep-alive") connections, e.g. [Patron](https://github.com/toland/patron) or [Typhoeus](https://github.com/typhoeus/typhoeus)._ These libraries are not dependencies of the elasticsearch gems, so be sure to define a dependency in your own application.
8181

8282
This repository contains these additional Ruby libraries:
8383

elasticsearch-transport/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,16 @@ Features overview:
2828
* Node reloading (based on cluster state) on errors or on demand
2929

3030
For optimal performance, use a HTTP library which supports persistent ("keep-alive") connections,
31-
such as [patron](https://github.com/toland/patron).
32-
Just require the library (`require 'patron'`) in your code,
33-
and it will be automatically used.
31+
such as [patron](https://github.com/toland/patron) or [Typhoeus](https://github.com/typhoeus/typhoeus).
32+
Just require the library (`require 'patron'`) in your code, and it will be automatically used.
3433

3534
Currently these libraries will be automatically detected and used:
3635
- [Patron](https://github.com/toland/patron)
36+
- [Typhoeus](https://github.com/typhoeus/typhoeus)
3737
- [HTTPClient](https://rubygems.org/gems/httpclient)
3838
- [Net::HTTP::Persistent](https://rubygems.org/gems/net-http-persistent)
3939

40-
**Note on [Typhoeus](https://github.com/typhoeus/typhoeus)**: Typhoeus is compatible and will be automatically detected too. However, the latest release (v1.3.1 at the moment of writing this) is not compatible with Faraday 1.0. [It still uses the deprecated `Faraday::Error` namespace](https://github.com/typhoeus/typhoeus/blob/v1.3.1/lib/typhoeus/adapters/faraday.rb#L100). If you want to use it with this gem, we suggest getting `master` from GitHub, since this has been fixed for v1.4.0. We'll update this if/when v1.4.0 is released.a
40+
**Note on [Typhoeus](https://github.com/typhoeus/typhoeus)**: You need to use v1.4.0 or up since older versions are not compatible with Faraday 1.0.
4141

4242
For detailed information, see example configurations [below](#transport-implementations).
4343

0 commit comments

Comments
 (0)