Skip to content

Commit

Permalink
docs: update docs to match logOn with refresh token behaviour
Browse files Browse the repository at this point in the history
  • Loading branch information
Sadzurami committed Oct 19, 2024
1 parent 999d79f commit 6fad05c
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 **(recommended)** and account name
- 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.
Expand Down

0 comments on commit 6fad05c

Please sign in to comment.