Skip to content

Commit 50840ac

Browse files
sunitaprajapati89sunitaprajapati89
authored
feat: updated README (#1069)
* feat: updated README * feat : made the cdnproxy note bold and more alarming
1 parent dec1642 commit 50840ac

1 file changed

Lines changed: 16 additions & 16 deletions

File tree

‎README.md‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -118,25 +118,25 @@ You must pass at least the `writeKey`. Additional configuration options are list
118118

119119
### Client Options
120120

121-
| **Name** | **Default** | **Description** |
122-
|----------------------------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
123-
| `writeKey` **(REQUIRED)** | '' | Your Segment API key. |
124-
| `collectDeviceId` | false | Set to true to automatically collect the device Id from the DRM API on Android devices. |
125-
| `debug` | true\* | When set to false, it will not generate any logs. |
126-
| `logger` | undefined | Custom logger instance to expose internal Segment client logging. |
127-
| `flushAt` | 20 | How many events to accumulate before sending events to the backend. |
128-
| `flushInterval` | 30 | In seconds, how often to send events to the backend. |
129-
| `flushPolicies` | undefined | Add more granular control for when to flush, see [Adding or removing policies](#adding-or-removing-policies). **Mutually exclusive with flushAt/flushInterval** |
130-
| `maxBatchSize` | 1000 | How many events to send to the API at once |
131-
| `trackAppLifecycleEvents` | false | Enable automatic tracking for [app lifecycle events](https://segment.com/docs/connections/spec/mobile/#lifecycle-events): application installed, opened, updated, backgrounded. |
132-
| `trackDeepLinks` | false | Enable automatic tracking for when the user opens the app via a deep link (Note: Requires additional setup on iOS, [see instructions](#ios-deep-link-tracking-setup)). |
121+
| **Name** | **Default** | **Description** |
122+
|----------------------------|--------------|------------------|
123+
| `writeKey` **(REQUIRED)** | '' | Your Segment API key. |
124+
| `collectDeviceId` | false | Set to true to automatically collect the device Id from the DRM API on Android devices. |
125+
| `debug` | true\* | When set to false, it will not generate any logs. |
126+
| `logger` | undefined | Custom logger instance to expose internal Segment client logging. |
127+
| `flushAt` | 20 | How many events to accumulate before sending events to the backend. |
128+
| `flushInterval` | 30 | In seconds, how often to send events to the backend. |
129+
| `flushPolicies` | undefined | Add more granular control for when to flush, see [Adding or removing policies](#adding-or-removing-policies). **Mutually exclusive with flushAt/flushInterval** |
130+
| `maxBatchSize` | 1000 | How many events to send to the API at once |
131+
| `trackAppLifecycleEvents` | false | Enable automatic tracking for [app lifecycle events](https://segment.com/docs/connections/spec/mobile/#lifecycle-events): application installed, opened, updated, backgrounded. |
132+
| `trackDeepLinks` | false | Enable automatic tracking for when the user opens the app via a deep link (Note: Requires additional setup on iOS, [see instructions](#ios-deep-link-tracking-setup)). |
133133
| `defaultSettings` | undefined | Settings that will be used if the request to get the settings from Segment fails. Type: [SegmentAPISettings](https://github.com/segmentio/analytics-react-native/blob/c0a5895c0c57375f18dd20e492b7d984393b7bc4/packages/core/src/types.ts#L293-L299) |
134-
| `autoAddSegmentDestination` | true | Set to false to skip adding the SegmentDestination plugin. |
134+
| `autoAddSegmentDestination` | true | Set to false to skip adding the SegmentDestination plugin. |
135135
| `storePersistor` | undefined | A custom persistor for the store that `analytics-react-native` leverages. Must match [`Persistor`](https://github.com/segmentio/analytics-react-native/blob/master/packages/sovran/src/persistor/persistor.ts#L1-L18) interface exported from [sovran-react-native](https://github.com/segmentio/analytics-react-native/blob/master/packages/sovran). |
136136
| `proxy` | undefined | `proxy` is a batch URL to post the events. Enable `useSegmentEndpoint` if proxy domain is provided and you want to append the Segment endpoints automatically. If you want to completely customize the proxy by providing a custom URL, disable `useSegmentEndpoint`. Default value is `false`. |
137-
| `errorHandler` | undefined | Create custom actions when errors happen, see [Handling errors](#handling-errors). |
138-
| `cdnProxy` | undefined | Sets an alternative CDN host for settings retrieval. Enable `useSegmentEndpoint` if cdnProxy domain is provided and you want to append the Segment endpoints automatically. |
139-
| `useSegmentEndpoint` | false | Set to `true` to automatically append the Segment endpoints when using `proxy` or `cdnProxy` to send or fetch settings. This will enable automatic routing to the appropriate endpoints. |
137+
| `errorHandler` | undefined | Create custom actions when errors happen, see [Handling errors](#handling-errors). |
138+
| `cdnProxy` | undefined | Sets an alternative CDN host for settings retrieval. Enable `useSegmentEndpoint` if `cdnProxy` domain is provided and you want to append the Segment endpoints automatically. <br><br>⚠️ **IMPORTANT NOTE:** *Prior to version 2.20.4, any value provided for `cdnProxy` was automatically appended with `/write-key/settings`. **Starting from v2.20.4**, this behavior has **CHANGED**—the SDK will now behave based on the `useSegmentEndpoint` flag.* Please update your configuration accordingly to avoid unexpected issues. ⚠️ |
139+
| `useSegmentEndpoint` | false | Set to `true` to automatically append the Segment endpoints when using `proxy` or `cdnProxy` to send or fetch settings. This will enable automatic routing to the appropriate endpoints. |
140140

141141

142142

0 commit comments

Comments
 (0)