README.md
# ElectricSQL Elixir client
An Elixir client for [ElectricSQL](https://electric-sql.com).
Electric is a sync engine that allows you to sync
[little subsets](https://electric-sql.com/docs/guides/shapes)
of data from Postgres into local apps and services. This client
allows you to sync data from Electric into Elixir applications.
## Installation
```elixir
def deps do
[
{:electric_client, "~> 0.1.0"}
]
end
```
## Usage
See the [Documentation](https://hexdocs.pm/electric_client).
## Testing
[Run Electric and Postgres](https://electric-sql.com/docs/guides/installation).
Define `DATABASE_URL` and `ELECTRIC_URL` as env vars. Or see the defaults in `config/runtime.exs`.
Then run:
```sh
mix test
```