README.md in keen-0.9.9 vs README.md in keen-0.9.10
- old
+ new
@@ -373,16 +373,23 @@
### Additional options
##### HTTP Read Timeout
-The default `Net:HTTP` timeout is 60 seconds. That's usually enough, but if you're querying over a large collection you may need to increase it. The timeout on the API side is 300 seconds, so that's as far as you'd want to go. You can configure a read timeout (in seconds) by setting a `KEEN_READ_TIMEOUT` environment variable, or by passing in a `read_timeout` option to the client constructor as follows:
+The default `Net::HTTP` timeout is 60 seconds. That's usually enough, but if you're querying over a large collection you may need to increase it. The timeout on the API side is 300 seconds, so that's as far as you'd want to go. You can configure a read timeout (in seconds) by setting a `KEEN_READ_TIMEOUT` environment variable, or by passing in a `read_timeout` option to the client constructor as follows:
``` ruby
keen = Keen::Client.new(:read_timeout => 300)
```
+You can also configure the `NET::HTTP` open timeout, default is 60 seconds. To configure the timeout (in seconds) either set `KEEN_OPEN_TIMEOUT` environment variable, or by passing in a `open_timeout` option to the client constructor as follows:
+
+``` ruby
+keen = Keen::Client.new(:open_timeout => 30)
+```
+
+
##### HTTP Proxy
You can set the `KEEN_PROXY_TYPE` and `KEEN_PROXY_URL` environment variables to enable HTTP proxying. `KEEN_PROXY_TYPE` should be set to `socks5`. You can also configure this on client instances by passing in `proxy_type` and `proxy_url` keys.
``` ruby
@@ -410,17 +417,20 @@
If you want some bot protection, check out the [Voight-Kampff](https://github.com/biola/Voight-Kampff) gem. Use the gem's `request.bot?` method to detect bots and avoid logging events.
### Changelog
+##### 0.9.10
++ Add ability to set the `open_time` setting for the http client.
+
##### 0.9.9
+ Added the ability to send additional optional headers.
##### 0.9.7
+ Added a new header `Keen-Sdk` that sends the SDK version information on all requests.
##### 0.9.6
-+ Updated behavior of saved queries to allow fetching results using the READ KEY as opposed to requiring the MASTER KEY, making the gem consistent with https://keen.io/docs/api/#getting-saved-query-results
++ Updated behavior of saved queries to allow fetching results using the READ KEY as opposed to requiring the MASTER KEY, making the gem consistent with https://keen.io/docs/api/#getting-saved-query-results
##### 0.9.5
+ Fix bug with scoped key generation not working with newer Keen projects.
##### 0.9.4