@studiohyperdrive/ngx-auth/README.md

A library of core authentication functionality used with @studiohyperdrive/types-auth.

# Angular Tools: Authentication (`@studiohyperdrive/ngx-auth`)

This library provides a basic setup for authentication flows within Angular applications.

## Installation

Install the package first:

```shell
npm install @studiohyperdrive/ngx-authentication
```

## Versioning and build information

This package will follow a semver-like format, `major.minor.patch`, in which:

- `major`: Follows the Angular major version
- `minor`: Introduces new features and (potential) breaking changes
- `patch`: Introduces bugfixes and minor non-breaking changes

## Documentation

To find more information regarding this package, we refer to [our documentation platform](https://open-source.studiohyperdrive.be/docs/angular/authentication/introduction).