Skip to content

Commit e18b3dd

Browse files
committed
Doco updates
1 parent 6766b93 commit e18b3dd

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ All `raygun-cli` commands share the same configuration parameters.
5959

6060
- App ID: The Application ID in Raygun.com.
6161
- Token: An access token from https://app.raygun.com/user/tokens.
62+
- API key: The API key of your application in Raygun.com
6263

6364
You can pass these parameters via arguments, e.g. `--app-id=<id>`
6465
or you can set them as environment variables.
@@ -69,6 +70,8 @@ Parameters passed as arguments have priority over environment variables.
6970
|-----------|----------|----------------------|
7071
| App ID | `app-id` | `RAYGUN_APP_ID` |
7172
| Token | `token` | `RAYGUN_TOKEN` |
73+
| API key | `api-key`| `RAYGUN_API_KEY` |
74+
7275

7376
#### Sourcemap Uploader
7477

@@ -113,8 +116,10 @@ Documentation: https://raygun.com/documentation/language-guides/android/crash-re
113116
raygun-cli proguard <arguments>
114117
```
115118

119+
Minimal required arguments are:
120+
116121
```
117-
raygun-cli proguard --app-id=APP_ID --token=TOKEN --version=<app version> --path=<Path to mapping.txt file> --external-access-token=<EAT from your Raygun user account settings> --overwrite
122+
raygun-cli proguard --app-id=APP_ID --version=<app version> --path=<Path to mapping.txt file> --external-access-token=<EAT from your Raygun user account settings> --overwrite
118123
```
119124

120125
Example outputs:
@@ -206,10 +211,10 @@ Send deployment tracking notifications to [raygun.com](https://raygun.com).
206211

207212
Documentation: https://raygun.com/documentation/product-guides/deployment-tracking/overview/
208213

209-
Minimal arguments are:
214+
Minimal required arguments are:
210215

211216
```
212-
raygun-cli depoyments --app-id=APP_ID --token=TOKEN --version=<app version> --api-key=<Raygun app API key>
217+
raygun-cli depoyments --token=TOKEN --version=<app version> --api-key=API_KEY
213218
```
214219

215220
Example outputs:

0 commit comments

Comments
 (0)