Various updates for version 6.0.0

README.md

@@ -23,7 +23,7 @@ by adding `hammer` to your list of dependencies in `mix.exs`:
 
 ```elixir
 def deps do
-  [{:hammer, "~> 5.0"}]
+  [{:hammer, "~> 6.0"}]
 end
 ```
 
@@ -66,9 +66,7 @@ Backends are configured via `Mix.Config`:
 ```elixir
 config :hammer,
   backend: {Hammer.Backend.ETS, [expiry_ms: 60_000 * 60 * 4,
-                                 cleanup_interval_ms: 60_000 * 10,
-                                 pool_size: 2,
-                                 pool_max_overflow: 4]}
+                                 cleanup_interval_ms: 60_000 * 10]}
 ```
 
 

doc_src/Tutorial.md

@@ -7,7 +7,7 @@ Add Hammer as a dependency in `mix.exs`:
 
 ```elixir
 def deps do
-  [{:hammer, "~> 5.0"}]
+  [{:hammer, "~> 6.0"}]
 end
 ```
 

lib/hammer/application.ex

@@ -14,11 +14,13 @@ defmodule Hammer.Application do
   options, and with the same effect:
 
   - `:expiry_ms` (int): expiry time in milliseconds, after which a bucket will
-    be deleted. The exact mechanism for cleanup will vary by backend
-  - `:pool_size` (int): size of the backend worker pool
+    be deleted. The exact mechanism for cleanup will vary by backend. This configuration
+    option is mandatory
+  - `:pool_size` (int): size of the backend worker pool (default=2)
   - `:pool_max_overflow` int(): number of extra workers the pool is permitted
     to spawn when under pressure. The worker pool (managed by the poolboy library)
     will automatically create and destroy workers up to the max-overflow limit
+    (default=0)
 
   Example of a single backend:
 
@@ -35,14 +37,14 @@ defmodule Hammer.Application do
               ets_table_name: :hammer_backend_ets_buckets,
               expiry_ms: 60_000 * 60 * 2,
               cleanup_interval_ms: 60_000 * 2,
-              pool_size: 2,
             ]
           },
           redis: {
             Hammer.Backend.Redis,
             [
               expiry_ms: 60_000 * 60 * 2,
-              redix_config: [host: "localhost", port: 6379]
+              redix_config: [host: "localhost", port: 6379],
+              pool_size: 4,
             ]
           }
         ]

mix.exs

@@ -13,7 +13,7 @@ defmodule Hammer.Mixfile do
       ],
       source_url: "https://github.com/ExHammer/hammer",
       homepage_url: "https://github.com/ExHammer/hammer",
-      version: "6.0.0-rc1",
+      version: "6.0.0",
       elixir: "~> 1.6",
       build_embedded: Mix.env() == :prod,
       start_permanent: Mix.env() == :prod,