README.md

# Memcache

[![Build Status](https://secure.travis-ci.org/ananthakumaran/memcachex.svg?branch=master)](http://travis-ci.org/ananthakumaran/memcachex)
[![Hex.pm](https://img.shields.io/hexpm/v/memcachex.svg)](https://hex.pm/packages/memcachex)

Memcached client for Elixir

## Installation

```elixir
defp deps() do
  [{:memcachex, "~> 0.2.1"}]
end

defp application() do
  [applications: [:logger, :memcachex]]
end
```

## Overview

Memcachex comes with two kinds of API, a high level one named
`Memcache` which provides functions to perform most of the common
usecases and a low level one named `Memcache.Connection` which
provides a less restrictive API. See the
[documenation](https://hexdocs.pm/memcachex) for more information

## Example

```elixir
{ :ok, pid } = Memcache.start_link()
{ :ok } = Memcache.set(pid, "hello", "world")
{ :ok, "world" } = Memcache.get(pid, "hello")
```

See test folder for further examples.