Skip to content

Commit dfe0e68

Browse files
Merge pull request #7 from asgardeo/pavinduLakshan-patch-1
Add installation instructions to README
2 parents 156bd41 + 59c9647 commit dfe0e68

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

README.md

+30-1
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,42 @@ The Asgardeo strategy is a custom implementation of the [OAuth2Strategy](https:/
2727

2828
## How to use
2929

30+
### Install the dependency
31+
32+
Using NPM:
33+
34+
```shell
35+
npm i @asgardeo/remix-auth-asgardeo
36+
```
37+
38+
Using Yarn:
39+
40+
```shell
41+
yarn add @asgardeo/remix-auth-asgardeo
42+
```
43+
44+
Using PNPM:
45+
46+
```shell
47+
pnpm add @asgardeo/remix-auth-asgardeo
48+
```
49+
50+
Using Bun:
51+
52+
```shell
53+
bun add @asgardeo/remix-auth-asgardeo
54+
```
55+
3056
### Create an Asgardeo organization
3157

3258
Head over to [Asgardeo](https://wso2.com/asgardeo) and sign up for an organization.
3359

3460
### Register an application
3561

36-
Follow the steps on the [Asgardeo documentation](https://wso2.com/asgardeo/docs/guides/applications/register-oidc-web-app/) to create an application and get the client ID, and client secret.
62+
Follow the steps on the [Asgardeo documentation](https://wso2.com/asgardeo/docs/guides/applications/register-oidc-web-app/) to create an application and get the client ID, and client secret. Provide the following values when required.
63+
64+
- Authorized redirect URL: `http://localhost:5173/auth/asgardeo/callback`
65+
- Allowed origins: `http://localhost:5173`
3766

3867
### Create the Asgardeo strategy instance
3968

0 commit comments

Comments
 (0)