2022-09-28 09:54:05 +13:00
# AshAuthentication
2023-01-18 02:50:55 +13:00
< img src = "https://github.com/ash-project/ash/blob/main/logos/ash-auth-logo.svg?raw=true" alt = "Ash Authentication Logo" width = "250" / >
2023-01-16 18:03:21 +13:00
![Elixir CI ](https://github.com/team-alembic/ash_authentication/workflows/Elixir%20Library/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_authentication.svg )](https://hex.pm/packages/ash_authentication)
2022-10-25 20:32:57 +13:00
AshAuthentication provides drop-in support for user authentication for users of
the [Ash framework ](https://ash-hq.org ). It is designed to be highly
configurable, with sensible defaults covering the most common use-cases.
2022-09-28 09:54:05 +13:00
## Installation
2022-10-25 20:32:57 +13:00
The package can be installed by adding `ash_authentication` to your list of
dependencies in `mix.exs` :
2022-09-28 09:54:05 +13:00
```elixir
def deps do
[
2024-03-28 15:06:20 +13:00
{:ash_authentication, "~> 4.0.0-rc.0"}
2022-09-28 09:54:05 +13:00
]
end
```
2022-10-25 20:32:57 +13:00
## Documentation
2023-01-27 09:31:26 +13:00
See the [official documentation ](https://ash-hq.org/docs/guides/ash_authentication/latest/tutorials/getting-started-with-authentication ) for more.
Additionally, documentation for the latest release will be [available on
2022-10-25 20:32:57 +13:00
hexdocs](https://hexdocs.pm/ash_authentication) and for the [`main`
branch](https://team-alembic.github.io/ash_authentication).
## Contributing
* To contribute updates, fixes or new features please fork and open a
pull-request against `main` .
2023-10-15 11:01:17 +13:00
* To regenerate cheat sheets for the DSLs, run `mix spark.cheat_sheets` . For new strategies ensure you've added them to the extensions and documentation groups in `mix.exs` .
2022-10-25 20:32:57 +13:00
* Please use [conventional
commits](https://www.conventionalcommits.org/en/v1.0.0/) - this allows us to
dynamically generate the changelog.
* Feel free to ask any questions on out [GitHub discussions
page](https://github.com/team-alembic/ash_authentication/discussions).
2022-09-28 09:54:05 +13:00
2022-11-14 16:44:53 +13:00
## Licence
2022-11-23 09:09:41 +13:00
`AshAuthentication` is licensed under the terms of the [MIT
license](https://opensource.org/licenses/MIT). See the [`LICENSE` file in this
repository](https://github.com/team-alembic/ash_authentication/blob/main/LICENSE)
for details.