Skip to content

Commit

Permalink
README
Browse files Browse the repository at this point in the history
  • Loading branch information
peillis committed May 9, 2017
1 parent 53d4a91 commit 105e54f
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 19 deletions.
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,24 @@ end

```elixir
config :memcachir,
hosts: "localhost"
hosts: "localhost",
# memcached options
ttl: 0,
namespace: nil

config :mero, # mero config is required
workers_per_shard: 1,
initial_connections_per_pool: 20,
min_free_connections_per_pool: 10,
max_connections_per_pool: 50,
timeout_read: 30,
timeout_write: 5000,
write_retries: 3,
expiration_time: 86400, # One day
connection_unused_max_time: 300000,
expiration_interval: 300000,
max_connection_delay_time: 5000,
stat_event_callback: {:mero_stat, :noop}
```

The `hosts` config allows multiple variants:
Expand All @@ -33,23 +50,6 @@ hosts: "localhost:11212" # specify port
hosts: ["host1", "host2", "host3:11212"] # cluster of servers
```

## Configuration

Complete configuration options with default values:

```elixir
config :memcachir,
hosts: "localhost",
# memcached options
ttl: 0,
namespace: nil,
# connection pool options
workers_per_shard: 1,
initial_connections_per_pool: 20,
min_free_connections_per_pool: 10,
max_connections_per_pool: 50
```

## Example

```elixir
Expand Down
1 change: 0 additions & 1 deletion lib/memcachir.ex
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ defmodule Memcachir do

alias Memcachir.Util


@doc """
Starts application.
"""
Expand Down

0 comments on commit 105e54f

Please sign in to comment.