Skip to content

Commit 59e77c6

Browse files
jparezjmaneyrol69
andcommitted
docs(readme): clarify wording and improve readability
Co-authored-by: Julien Maneyrol <[email protected]>
1 parent bb35624 commit 59e77c6

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -141,17 +141,17 @@ Do not send both headers at once.
141141

142142
Flow to render a SaaS device:
143143

144-
1. Authenticate with one scheme:
144+
1. Authenticate with either one of these schemes (not both!):
145145
- JWT: `POST /v1/users/login` → response contains `token` (your JWT).
146146
- API token: skip login and use `x-api-token` directly.
147147
2. Get your instance info (for `webrtcAddress`): `GET /v1/instances/<INSTANCE_UUID>` using your chosen header.
148148
3. Generate the per-instance access token: `POST /v1/instances/access-token` with body `{"instance_uuid":"<INSTANCE_UUID>"}` using the same header.
149149
4. Use the returned `access_token` as `options.token` when calling `setupRenderer`.
150150

151151
Notes:
152-
- SaaS JWTs expire (e.g., ~48h). Regenerate by re-login when needed.
152+
- SaaS JWTs expire after a while (e.g., ~48h). Regenerate by re-login when needed.
153153
- The `access_token` is scoped to a single instance and may expire; if you receive a token invalid/expired error, call the access-token endpoint again and reconnect.
154-
- For PaaS, `options.token` is the instance ID provided by your device provider. No SaaS API calls are required.
154+
- For Genymotion Device Image, `options.token` is the instance ID provided by your cloud provider. No SaaS API calls are required.
155155

156156
Useful references:
157157
- Login (JWT): https://developer.genymotion.com/saas/#operation/login

0 commit comments

Comments
 (0)