Authentication for the modern web!
API
•
Docs
•
Demo
[![NPM Version][npm-version-image]][npm-url]
[![NPM Downloads][npm-downloads-image]][npm-url]
[![CI Build][github-actions-image]][github-actions-url]
[![Coveralls][coveralls-image]][coveralls-url]
[![semantic-release][semantic-release-image]][semantic-release-url]
## Install
```sh
$ npm install @salte-auth/salte-auth
```
## Usage
```js
import { SalteAuth } from '@salte-auth/salte-auth';
import { Auth0 } from '@salte-auth/auth0';
import { Tab } from '@salte-auth/tab';
// Configure SalteAuth with Auth0's url and client id.
const auth = new SalteAuth({
providers: [
new Auth0({
url: 'https://salte-os.auth0.com',
clientID: '9JTBXBREtckkFHTxTNBceewrnn7NeDd0'
})
],
handlers: [
new Tab({
default: true
})
]
});
// Display an iframe to the user that allows them to login
auth.login('auth0');
```
## Known Issues
_These are issues that we know about, but don't have a clear fix for!_
**There are currently no known issues, thanks for checking!**
[npm-version-image]: https://img.shields.io/npm/v/@salte-auth/salte-auth.svg?style=flat
[npm-downloads-image]: https://img.shields.io/npm/dm/@salte-auth/salte-auth.svg?style=flat
[npm-url]: https://npmjs.org/package/@salte-auth/salte-auth
[github-actions-image]: https://github.com/salte-auth/salte-auth/actions/workflows/ci.yml/badge.svg?branch=main
[github-actions-url]: https://github.com/salte-auth/salte-auth/actions/workflows/ci.yml
[coveralls-image]: https://img.shields.io/coveralls/salte-auth/salte-auth.svg
[coveralls-url]: https://coveralls.io/github/salte-auth/salte-auth?branch=main
[semantic-release-url]: https://github.com/semantic-release/semantic-release
[semantic-release-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
