Mirrors/svelte.sk-auth
1
0
Fork 0
mirror of https://github.com/Dan6erbond/sk-auth.git synced 2024-11-20 19:07:20 +01:00
Code Issues Projects Releases Wiki Activity

📝 Add installation instructions to README.md

Browse Source
This commit is contained in:
RaviAnand Mohabir 2021-05-24 21:03:45 +02:00
parent 9f77d2b0fd
commit feba7dc301
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -9,6 +9,24 @@
Authentication library for use with SvelteKit featuring built-in OAuth providers and zero restriction customization!
## Installation
SvelteKitAuth is available on NPM as `sk-auth`, it can be installed with NPM:
```bash
npm i sk-auth --save
```
Or Yarn:
```bash
yarn add sk-auth
```
### Usage with Typescript
SvelteKitAuth also comes with first-class support for Typescript out of the box, so no need to add an additional `@types/` dev dependency! 🎉
## Getting Started
SvelteKitAuth is very easy to setup! All you need to do is instantiate the `SvelteKitAuth` class, and configure it with some default providers, as well as a JWT secret key used to verify the cookies: