ash_archival/README.md

25 lines
587 B
Markdown
Raw Normal View History

2022-07-14 06:29:49 +12:00
# Ash Archival
2022-07-14 07:08:54 +12:00
A small but useful resource extension for [Ash Framework](https://github.com/ash-project/ash), which configures resources to be archived instead of destroyed.
2022-07-14 06:29:49 +12:00
## Installation
The package can be installed by adding `ash_archival` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
2022-11-07 08:18:08 +13:00
{:ash_archival, "~> 0.1"}
2022-07-14 06:29:49 +12:00
]
end
```
2022-11-07 08:18:08 +13:00
## Using the archive extension
On your ash resource add `AshArchival.Resource` to your extensions. For more details see the docs at https://ash-hq.org.
```elixir
use Ash.Resource,
extensions: [AshArchival.Resource]
```