Skip to content
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

Updates README #836

Merged
merged 5 commits into from
Oct 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed .github/auth_strategies.png
Binary file not shown.
Binary file added .github/list-user.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/user-info.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 24 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,9 @@ Supertokens architecture is optimized to add secure authentication for your user
2. Backend SDK: Provides APIs for sign-up, sign-in, signout, session refreshing, etc. Your Frontend will talk to these APIs
3. SuperTokens Core: The HTTP service for the core auth logic and database operations. This service is used by the Backend SDK

## Supports multiple auth strategies
## Get Started Now

![auth recipes](.github/auth_strategies.png)

Guides to setup different recipes
SuperTokens has the following features:

* [Passwordless](https://supertokens.com/docs/passwordless/introduction)
* [Social Login](https://supertokens.com/docs/thirdparty/introduction)
Expand All @@ -31,6 +29,10 @@ Guides to setup different recipes
* [Passwordless + Social Login](https://supertokens.com/docs/thirdpartypasswordless/introduction)
* [Email Password + Social Login](https://supertokens.com/docs/thirdpartyemailpassword/introduction)
* [Session Management](https://supertokens.com/docs/session/introduction)
* [Multi-Factor Authentication](https://supertokens.com/docs/mfa/introduction)
* [Multi Tenancy / Organization Support (Enterprise SSO)](https://supertokens.com/docs/multitenancy/introduction)
* [User Roles](https://supertokens.com/docs/userroles/introduction)
* [Microservice Authentication](https://supertokens.com/docs/microservice_auth/introduction)

## Learn more
- [🚀 What is SuperTokens?](https://github.com/supertokens/supertokens-core#-what-is-supertokens)
Expand All @@ -39,6 +41,7 @@ Guides to setup different recipes
- [Documentation](https://github.com/supertokens/supertokens-core#documentation)
- [🏗️ Architecture](https://github.com/supertokens/supertokens-core#%EF%B8%8F-architecture)
- [☕ Why Java?](https://github.com/supertokens/supertokens-core#-why-java)
- [⌨️ User Management Dashboard](https://github.com/supertokens/supertokens-core#-user-management-dashboard)
- [🔥 SuperTokens vs Others](https://github.com/supertokens/supertokens-core#-supertokens-vs-others)
- [🛠️ Building from source](https://github.com/supertokens/supertokens-core#%EF%B8%8F-building-from-source)
- [👥 Community](https://github.com/supertokens/supertokens-core#-community)
Expand Down Expand Up @@ -95,6 +98,23 @@ Please find an [architecture diagram here](https://supertokens.io/docs/community
- We also plan on using [GraalVM](https://www.graalvm.org/) in the future and this can reduce memory usage by 95%!
- ✅ If you require any modifications to the auth APIs, those would need to be done on the backend SDK level (for example Node, Golang, Python..). So you’d rarely need to directly modify/work with the Java code in this repo.

## ⌨️ User Management Dashboard

Oversee your users with the [SuperTokens User Management Dashboard](https://supertokens.com/docs/userdashboard/about)


### List users

List all the users who have signed up to your application.

![List SuperTokens users](.github/list-user.png)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

change screenshot


### Manage users

Manage users by modifying or deleting their sessions, metadata, roles and account info.

![Manage users](.github/user-info.png)

## 🔥 SuperTokens vs others
Please find a detailed comparison chart [on our website](https://supertokens.io/pricing#comparison-chart)

Expand Down