From d0a4f630bfb2200abbd01a1769e65f7e51273c95 Mon Sep 17 00:00:00 2001 From: Sadzurami Date: Sat, 19 Oct 2024 17:10:54 +0300 Subject: [PATCH] docs: update docs to match logOn with refresh token behaviour --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fbd6615b..48679773 100644 --- a/README.md +++ b/README.md @@ -568,8 +568,9 @@ There are five ways to log onto Steam: default to logging on anonymously. This is still current behavior, but logging on in this manner is now deprecated. If you now call `logOn()` without providing a `refreshToken` or `accountName` and without specifying `anonymous: true`, then steam-user will raise a warning and then log on anonymously. -- Individually using a refresh token **(recommended)** +- Individually using a refresh token and account name **(recommended)** - These properties are required: + - `accountName` - `refreshToken` - These properties are optional: - `steamID` - If provided, steam-user will check to make sure that the provided `refreshToken` matches this SteamID. If SteamIDs don't match, the app will crash. @@ -577,7 +578,6 @@ There are five ways to log onto Steam: - `machineName` - Defaults to empty string if not specified. - `clientOS` - Defaults to an auto-detected value if not specified. - These properties must not be provided: - - `accountName` - `password` - `machineAuthToken` - `webLogonToken`