README.md

# BeamHomunculus

A bot framework for ErlangVM(beam)

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed as:

  1. Add `beam_homunculus` to your list of dependencies in `mix.exs`:

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

  2. Ensure `beam_homunculus` is started before your application:

    ```elixir
    def application do
      [applications: [:beam_homunculus]]
    end
    ```

If [published on Hexdocs](https://hex.pm/docs/tasks#hex_docs), the docs can
be found at [https://hexdocs.pm/beam_homunculus](https://hexdocs.pm/beam_homunculus)