mirror of
https://github.com/team-alembic/ash_authentication.git
synced 2024-09-20 05:13:10 +12:00
50 lines
2 KiB
Markdown
50 lines
2 KiB
Markdown
# AshAuthentication
|
|
|
|
<img src="https://github.com/ash-project/ash/blob/main/logos/ash-auth-logo.svg?raw=true" alt="Ash Authentication Logo" width="250"/>
|
|
|
|
|
|
[](https://opensource.org/licenses/MIT)
|
|
[](https://hex.pm/packages/ash_authentication)
|
|
|
|
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.
|
|
|
|
## Installation
|
|
|
|
The package can be installed by adding `ash_authentication` to your list of
|
|
dependencies in `mix.exs`:
|
|
|
|
```elixir
|
|
def deps do
|
|
[
|
|
{:ash_authentication, "~> 4.0.0-rc.5"}
|
|
]
|
|
end
|
|
```
|
|
|
|
## Documentation
|
|
|
|
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
|
|
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`.
|
|
- 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`.
|
|
- 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).
|
|
|
|
## Licence
|
|
|
|
`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.
|