README.md

# README

**plymio\_vekil**: A *vekil* is a collection that associates *proxies with *foroms*.

A *vekil* may be thought of as a dictionary where a *proxy* is a `key`
and its `value` is a *forom*.

## Installation

Add **plymio\_vekil** to your list of dependencies in *mix.exs*:

    def deps do
      [{:plymio_vekil, "~> 0.1.0"}]
    end

## Examples

See the examples in the [API Reference](<https://hexdocs.pm/plymio_vekil/api-reference.html>).

## Dialyzer Warnings

Running dialyzer will likely give rise to many warnings for built-in
datatypes with implementations.  See
[#7708](https://github.com/elixir-lang/elixir/issues/7708)