README.md in dalli-3.0.2 vs README.md in dalli-3.0.3
- old
+ new
@@ -3,11 +3,11 @@
Dalli is a high performance pure Ruby client for accessing memcached servers. It works with memcached 1.4+ only as it uses the newer binary protocol. It should be considered a replacement for the memcache-client gem.
The name is a variant of Salvador Dali for his famous painting [The Persistence of Memory](http://en.wikipedia.org/wiki/The_Persistence_of_Memory).
-
+
Dalli's initial development was sponsored by [CouchBase](http://www.couchbase.com/). Many thanks to them!
Supported Ruby versions and implementations
------------------------------------------------
@@ -79,13 +79,13 @@
**threadsafe**: Boolean. If true Dalli ensures that only one thread is using a socket at a given time. Default is true. You can set to false if you are using the Client within a thread-safe connection pool.
**serializer**: The serializer to use for objects being stored (ex. JSON).
Default is Marshal.
-**compress**: Boolean, if true Dalli will gzip-compress values larger than compression_min_size. Default is true.
+**compress**: Boolean, if true Dalli will gzip-compress values larger than compression_min_size. Can be overridden on a per-request basis. Default is true.
-**compression_min_size**: Minimum value byte size for which to attempt compression. Default is 1K.
+**compression_min_size**: Minimum value byte size for which to attempt compression. Default is 4K.
**compressor**: The compressor to use for objects being stored.
Default is zlib, implemented under `Dalli::Compressor`.
If serving compressed data using nginx's HttpMemcachedModule, set `memcached_gzip_flag 2` and use `Dalli::GzipCompressor`
@@ -99,12 +99,10 @@
**down_retry_delay**: When a server has been marked down due to many failures, the server will be checked again for being alive only after this amount of time. Don't set this value too low, otherwise each request which tries the failed server might hang for the maximum **socket_timeout**. Default is 30 seconds.
**value_max_bytes**: The maximum size of a value in memcached. Defaults to 1MB, this can be increased with memcached's -I parameter. You must also configure Dalli to allow the larger size here.
-**error_when_over_max_size**: Boolean. If true, Dalli will throw a Dalli::ValueOverMaxSize exception when trying to store data larger than **value_max_bytes**. Defaults to false, meaning only a warning is logged.
-
**username**: The username to use for authenticating this client instance against a SASL-enabled memcached server. Heroku users should not need to use this normally.
**password**: The password to use for authenticating this client instance against a SASL-enabled memcached server. Heroku users should not need to use this normally.
**sndbuf**: In bytes, set the socket SO_SNDBUF. Defaults to operating system default.
@@ -133,10 +131,10 @@
Helping Out
-------------
If you have a fix you wish to provide, please fork the code, fix in your local project and then send a pull request on github. Please ensure that you include a test which verifies your fix and update `History.md` with a one sentence description of your fix so you get credit as a contributor.
-We're not accepting new compressors. They are trivial to add in an initializer. See #385 (LZ4), #406 (Snappy)
+We're not accepting new compressors. They are trivial to add in an initializer. See [#385](https://github.com/petergoldstein/dalli/pull/385) (LZ4), [#406](https://github.com/petergoldstein/dalli/pull/406) (Snappy)
Thanks
------------
Mike Perham - for originally authoring the Dalli project and serving as maintainer and primary contributor