Skip to content

Commit

Permalink
Doco updates
Browse files Browse the repository at this point in the history
  • Loading branch information
TheRealAgentK committed Jan 27, 2025
1 parent 6766b93 commit e18b3dd
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ All `raygun-cli` commands share the same configuration parameters.

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

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


#### Sourcemap Uploader

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

Minimal required arguments are:

```
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
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
```

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

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

Minimal arguments are:
Minimal required arguments are:

```
raygun-cli depoyments --app-id=APP_ID --token=TOKEN --version=<app version> --api-key=<Raygun app API key>
raygun-cli depoyments --token=TOKEN --version=<app version> --api-key=API_KEY
```

Example outputs:
Expand Down

0 comments on commit e18b3dd

Please sign in to comment.