You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-153Lines changed: 2 additions & 153 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,160 +16,9 @@ Reading the short [Basic Terms](https://github.com/FeatureProbe/FeatureProbe/blo
16
16
17
17
Reading the short [Doc](https://github.com/FeatureProbe/feature-probe-docs/blob/b8c55a35c771e4223469f1b121f8b78ab3d9bc22/docs/sdk/sdk-introduction.md?plain=1#L13-L34) about core data sturtures. [中文](https://github.com/FeatureProbe/feature-probe-docs/blob/b8c55a35c771e4223469f1b121f8b78ab3d9bc22/i18n/zh-CN/docusaurus-plugin-content-docs/current/sdk/sdk-introduction.md?plain=1#L14-L35)
18
18
19
-
## Try Out Demo Code
19
+
## How to use this SDK
20
20
21
-
We provide a runnable [demo](https://github.com/FeatureProbe/client-sdk-js/tree/main/example) for you to understand how FeatureProbe SDK is used.
22
-
23
-
1. Use featureprobe.io online service. [Go to](https://featureprobe.io/login)
24
-
25
-
Or setup FeatureProbe service with docker composer. [How to](https://github.com/FeatureProbe/FeatureProbe#1-starting-featureprobe-service-with-docker-compose)
| user | yes | n/a | The User with attributes like name, age is used when toggle evaluation |
159
-
| clientSdkKey | yes | n/a | The Client SDK Key is used to authentification |
160
-
| remoteUrl | depends | n/a | The unified URL to get toggles and post events |
161
-
| togglesUrl | no | n/a | The specific URL to get toggles, once set, remoteUrl will be ignored |
162
-
| eventsUrl | no | n/a | The specific URL to post events, once set, remoteUrl will be ignored |
163
-
| refreshInterval | no | 1000 | The SDK check for updated in millisecond |
164
-
165
-
## Testing
166
-
167
-
We have unified integration tests for all our SDKs. Integration test cases are added as submodules for each SDK repo. So
168
-
be sure to pull submodules first to get the latest integration tests before running tests.
169
-
170
-
```js
171
-
npm run test
172
-
```
21
+
See [SDK Doc](https://docs.featureprobe.io/sdk/Client-Side%20SDKs/javascript-sdk/) for detail. [中文](https://docs.featureprobe.io/zh-CN/sdk/Client-Side%20SDKs/javascript-sdk)
0 commit comments