README.md
<p align="center">
<a href="https://electric-sql.com" target="_blank">
<picture>
<source media="(prefers-color-scheme: dark)"
srcset="https://raw.githubusercontent.com/electric-sql/meta/main/identity/ElectricSQL-logo-next.svg"
/>
<source media="(prefers-color-scheme: light)"
srcset="https://raw.githubusercontent.com/electric-sql/meta/main/identity/ElectricSQL-logo-black.svg"
/>
<img alt="ElectricSQL logo"
src="https://raw.githubusercontent.com/electric-sql/meta/main/identity/ElectricSQL-logo-black.svg"
/>
</picture>
</a>
</p>
# Electric.Phoenix
## Work in progress.
An adapter to integrate [Electric SQL's sync engine](https://electric-sql.com) into [Phoenix web applications](https://www.phoenixframework.org/).
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `electric_phoenix` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:electric_phoenix, "~> 0.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/electric_phoenix>.