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 8c2bad3 commit d0a4f63
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -568,16 +568,16 @@ 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.
- `logonID` - Defaults to 0 if not specified.
- `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`
Expand Down

0 comments on commit d0a4f63

Please sign in to comment.