<!--
SPDX-FileCopyrightText: 2022 ash_archival contributors <https://github.com/ash-project/ash_archival/graphs.contributors>

SPDX-License-Identifier: MIT
-->

![Logo](https://github.com/ash-project/ash/blob/main/logos/cropped-for-header-black-text.png?raw=true#gh-light-mode-only)
![Logo](https://github.com/ash-project/ash/blob/main/logos/cropped-for-header-white-text.png?raw=true#gh-dark-mode-only)

![Elixir CI](https://github.com/ash-project/ash_archival/workflows/CI/badge.svg)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Hex version badge](https://img.shields.io/hexpm/v/ash_archival.svg)](https://hex.pm/packages/ash_archival)
[![Hexdocs badge](https://img.shields.io/badge/docs-hexdocs-purple)](https://hexdocs.pm/ash_archival)
[![REUSE status](https://api.reuse.software/badge/github.com/ash-project/ash_archival)](https://api.reuse.software/info/github.com/ash-project/ash_archival)

# AshArchival

AshArchival is an [Ash](https://hexdocs.pm/ash) extension that provides a push-button solution for soft deleting records, instead of destroying them.

## Tutorials

- [Get Started with AshArchival](documentation/tutorials/get-started-with-ash-archival.md)

## Topics

- [How does AshArchival work?](documentation/topics/how-does-ash-archival-work.md)
- [Unarchiving](documentation/topics/unarchiving.md)
- [Upgrading to 2.0](documentation/topics/upgrading-to-2.0.md)

## Reference

- [AshArchival DSL](documentation/dsls/DSL-AshArchival.Resource.md)