README.md

# Notified

An Elixir library for application notifications

## Installation

Add the `notified` package to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [{:notified, "~> 0.0.1"}]
end
```

## Usage

Create & manage a notification

```elixir
notification = Notifed.create("10 users have signed up in the last 5 minutes")
Notifed.seen(notification.id)
Notifed.acknowledged(notification.id)
Notifed.archive(notification.id)
Notifed.delete(notification.id)
```

Phoenix LiveView component

```
<%= live_component Notified.LiveView.New %>
<%= live_component Notified.LiveView.List %>
```

## Authors

- Alex Kwiatkowski - alex+git@fremantle.io

## License

`notified` is released under the [MIT license](./LICENSE)