-
Notifications
You must be signed in to change notification settings - Fork 6
Update README.md #37
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
pfvatterott
wants to merge
2
commits into
main
Choose a base branch
from
Update-README
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Update README.md #37
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| <p align="center"> | ||
| <a href="https://www.propelauth.com?ref=github" target="_blank" align="center"> | ||
| <img src="https://propelauth-logos.s3.us-west-2.amazonaws.com/logo-only.png" width="100"> | ||
| <img src="https://www.propelauth.com/imgs/lockup.svg" width="200"> | ||
| </a> | ||
| </p> | ||
|
|
||
|
|
@@ -17,6 +17,60 @@ Your frontend gets a beautiful, safe, and customizable login screen. Your backen | |
| - Full reference this library is [here](https://docs.propelauth.com/reference/frontend-apis/js) | ||
| - Getting started guides for PropelAuth are [here](https://docs.propelauth.com/) | ||
|
|
||
| ## Installation and Usage | ||
|
|
||
| ```bash | ||
| npm install @propelauth/javascript | ||
| ``` | ||
|
|
||
| and then you can import it: | ||
|
|
||
| ```js | ||
| import { createClient } from "@propelauth/javascript"; | ||
| ``` | ||
|
|
||
| Alternatively, you can use a CDN: | ||
|
|
||
| ```html | ||
| <script | ||
| src="https://www.unpkg.com/@propelauth/[email protected]/dist/javascript.min.js" | ||
| integrity="sha384-FENNH2f7QuQvkZJBL7jebLr0OtYKgTA2iq+C5g3VXXX7SBwWmeMMoc+pBBtcn76G" | ||
| crossorigin="anonymous"></script> | ||
| ``` | ||
|
|
||
| then a global PropelAuth object will be created, and you can call createClient from it: | ||
|
|
||
| ```html | ||
| <script> | ||
| PropelAuth.createClient({...}); | ||
| </script> | ||
| ``` | ||
|
|
||
| ## Using the Javascript library | ||
|
|
||
| You'll create a client using the [createClient](#create-client) function, and then you can use the client to get information about the current user. | ||
|
|
||
| You can also enabled background token refresh, which will automatically refresh the user's information periodically and on key events (e.g. user switches tabs, reconnects to the internet, etc). | ||
|
|
||
|
|
||
| ### createClient | ||
|
|
||
| Creates an authentication client which manages your user's [access token](https://docs.propelauth.com/guides-and-examples/guides/access-tokens), fetches user information, and provides other useful authentication functions. | ||
|
|
||
| The client also refreshes auth information when a user switches focus to your tab or reconnects (if they were offline). | ||
|
|
||
| ```js | ||
| const authClient = createClient({ | ||
| // The base URL where your authentication pages are hosted. | ||
| // You can find this under the Frontend Integration section for your project. | ||
| authUrl: "https://auth.yourdomain.com", | ||
|
|
||
| // If true, periodically refresh the access token in the background. | ||
| // This helps ensure you always have a valid token ready to go. Default true. | ||
| enableBackgroundTokenRefresh: true, | ||
| }); | ||
| ``` | ||
|
|
||
| ## Questions? | ||
|
|
||
| Feel free to reach out at [email protected] | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.