README.md

# Epik Elixir

Client library for the [Epik.com v2 API](https://docs.userapi.epik.com/v2/).

## Installation

The package can be installed by adding `epik` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:epik, "~> 0.1.0"}
  ]
end
```

### Configuration

You will then need to configure Epik for your application.

```elixir
import Config

config :epik,
  signature: "****-****-****-****",
  endpoint: "https://usersapiv2.epik.com"
```

#### Supported options

- `signature` (**required**): Found in the API Settings of your Epik account.
- `endpoint` (**required**): The endpoint to use for requests. Set this to Epik's API endpoint in production. There is no default for safety reasons.

## License

Epik Elixir is licensed under the MIT license.
See `LICENSE.md` for a full copy of the license.