@retter/sdk 0.2.30 → 0.2.35

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.MD CHANGED
@@ -17,6 +17,7 @@ Using unkpg:
17
17
  ```html
18
18
  <script src="https://unpkg.com/@retter/sdk/bundle/index.js"></script>
19
19
  ```
20
+ > You can use global `Retter` keyword.
20
21
 
21
22
  ## Usage
22
23
 
@@ -25,12 +26,26 @@ Using unkpg:
25
26
  Clients should initialize with project id. Instances with same project id always be cached.
26
27
 
27
28
  ```ts
28
- const rio = Retter.getInstance({
29
- projectId: '{PROJECT_ID}',
30
- })
29
+ import Retter from '@retter/sdk'
30
+
31
+ const rio = Retter.getInstance(config: RetterClientConfig)
32
+
33
+ interface RetterClientConfig {
34
+ projectId: string
35
+ rootProjectId?: string
36
+ region?: RetterRegion
37
+ platform?: string
38
+ culture?: string
39
+ }
31
40
  ```
32
41
 
33
- **PROJECT_ID**: Unique id of a project created in [retter.io Console](https://retter.io)
42
+ > **projectId**: Unique id of a project created in [retter.io Console](https://retter.io)
43
+ >
44
+ > **region**: Could be `euWest1` or `euWest1Beta`
45
+ >
46
+ > **platform**: web, react-native, vs...
47
+ >
48
+ > **culture**: tr, en-US, vs....
34
49
 
35
50
  ### Authentication
36
51