README.md

# BubbleLib

[![Elixir CI](https://github.com/botsquad/bubble_lib/actions/workflows/elixir.yml/badge.svg)](https://github.com/botsquad/bubble_lib/actions/workflows/elixir.yml) [![Hex.pm Version](http://img.shields.io/hexpm/v/bubble_lib.svg?style=flat)](https://hex.pm/packages/bubble_lib)

BubbleLib contains a collection of utility functions for BubbleScript,
the conversational DSL powering the
[Botsquad](https://www.botsquad.com/) platform.

- `BubbleLib.Builtins` — BubbleScript's [builtin functions](https://doc.botsquad.com/dsl/builtins/) and "loose" operators
- `BubbleLib.XML` — XML handling (parse / build / query), using `:xmerl`
- `BubbleLib.AutoMap` — "Easy" lossy / auto maps / array access
- `%BubbleLib.AutoMap.ETS{}` for storing large collections in AutoMap

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `bubble_lib` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:bubble_lib, "~> 1.0"}
  ]
end
```

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/bubble_lib](https://hexdocs.pm/bubble_lib).