README.md

# LiveFlip

[![Hex.pm Version](https://img.shields.io/hexpm/v/live_flip.svg)](https://hex.pm/packages/live_flip) [![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://hexdocs.pm/live_flip/)

A component and hook for FLIP animations of elements within LiveView.

## Installation

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

```elixir
def deps do
  [
    {:live_flip, ">= 0.0.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/live_flip>.

## Contributing

Feel free to fork and make PRs! I'm definitely happy to have eyes on this and to get feedback so we can take care of edge cases.