From 50ebe54cd92c48130523e1f67a26d81d13cff0ee Mon Sep 17 00:00:00 2001 From: Anders Date: Thu, 2 May 2024 19:16:57 +0200 Subject: [PATCH] Added docs to explain authentication Added a sentence to indicate that tokens are captured by the SDK from the response headers when making requests to authenticate the user. --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 067e3d4..faf68cd 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ Future makeRequest() { } ``` -The SuperTokens SDK will handle session expiry and automatic refreshing for you. +The SuperTokens SDK will handle session expiry and automatic refreshing for you. When calling authentication APIs such as signin or signup, the SDK automatically captures the access- and refresh tokens from the headers and saves them for you. #### Using a custom `http` Client @@ -143,10 +143,13 @@ Future manualRefresh() async { ``` ## Contributing + Please refer to the [CONTRIBUTING.md](https://github.com/supertokens/supertokens-flutter/blob/master/CONTRIBUTING.md) file in this repo. ## Contact us + For any queries, or support requests, please email us at team@supertokens.com, or join our [Discord](supertokens.com/discord) server. ## Authors + Created with :heart: by the folks at SuperTokens.com.