Skip to content

Commit 8cbec35

Browse files
authored
docs: cover appVersion option (#81)
1 parent c99a2af commit 8cbec35

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,9 @@ You can configure the client's network connection and key storage method with th
103103
| Parameter | Default | Description |
104104
| --------- | ------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
105105
| env | `DEV` | Connect to the specified XMTP network environment. Valid values include `DEV`, `.PRODUCTION`, or `LOCAL`. For important details about working with these environments, see [XMTP `production` and `dev` network environments](#xmtp-production-and-dev-network-environments). |
106+
| appVersion | `undefined` | Add a client app version identifier that's included with API requests.<br/>For example, you can use the following format: `appVersion: APP_NAME + '/' + APP_VERSION`.<br/>Setting this value provides telemetry that shows which apps are using the XMTP client SDK. This information can help XMTP developers provide app support, especially around communicating important SDK updates, including deprecations and required upgrades. |
107+
108+
**Configure `env`**
106109

107110
```kotlin
108111
// Configure the client to use the `production` network
@@ -111,7 +114,7 @@ val client = Client().create(account = account, options = options)
111114
```
112115

113116
> **Note**
114-
> The `apiUrl`, `keyStoreType`, `codecs`, `maxContentSize`, and `appVersion` parameters from the XMTP client SDK for JavaScript (xmtp-js) are not yet supported.
117+
> The `apiUrl`, `keyStoreType`, `codecs`, and `maxContentSize` parameters from the XMTP client SDK for JavaScript (xmtp-js) are not yet supported.
115118
116119
## Handle conversations
117120

0 commit comments

Comments
 (0)