Merge pull request #3 from FeatureProbe/fpuser

feat: FPUser auto generate key

Author: SSebo

README.md

@@ -16,160 +16,9 @@ Reading the short [Basic Terms](https://github.com/FeatureProbe/FeatureProbe/blo
 
 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)
 
-## Try Out Demo Code
+## How to use this SDK
 
-We provide a runnable [demo](https://github.com/FeatureProbe/client-sdk-js/tree/main/example) for you to understand how FeatureProbe SDK is used.
-
-1. Use featureprobe.io online service. [Go to](https://featureprobe.io/login)
-   
-   Or setup FeatureProbe service with docker composer. [How to](https://github.com/FeatureProbe/FeatureProbe#1-starting-featureprobe-service-with-docker-compose)
-
-2. Download this repo and run the demo program:
-```bash
-git clone https://github.com/FeatureProbe/client-sdk-js.git
-cd client-sdk-js
-// open example/index.html in browser
-```
-
-3. Find the Demo code [here](https://github.com/FeatureProbe/client-sdk-js/tree/main/example), 
-do some change and run the program again.
-```
-// open example/index.html in browser
-```
-
-## Step-by-Step Guide
-
-In this guide we explain how to use feature toggles in a JavaScript application using FeatureProbe.
-
-### Step 1. Install the JavaScript SDK
-
-First, install the FeatureProbe SDK as a dependency in your application.
-
-NPM:
-
-```js
-npm install featureprobe-client-sdk-js --save
-```
-
-Or via CDN:
-
-```js
-<script type="text/javascript" src="https://unpkg.com/featureprobe-client-sdk-js@latest/dist/featureprobe-client-sdk-js.min.js"></script>
-```
-
-### Step 2. Create a FeatureProbe instance
-
-After you install and import the SDK, create a single, shared instance of the FeatureProbe SDK.
-
-NPM:
-
-```js
-import { FeatureProbe, FPUser } from "featureprobe-client-sdk-js";
-
-const userId = /* unique user id in your business logic */;
-const user = new FPUser(userId);
-user.with("userId", /* userId */);
-
-const remoteUrl = "https://featureprobe.io/server";
-// const remoteUrl = "http://localhost:4007";   // for local docker
-
-const fp = new FeatureProbe({
-  remoteUrl,
-  clientSdkKey: /* clientSdkKey */,
-  user
-});
-
-fp.start();
-```
-
-Or via CDN:
-
-```js
-const userId = /* unique user id in your business logic */;
-const user = new FPUser(userId);
-user.with("userId", /* userId */);
-
-const remoteUrl = "https://featureprobe.io/server";
-// const remoteUrl = "http://localhost:4007";   // for local docker
-
-const fp = new featureProbe.FeatureProbe({
-  remoteUrl,
-  clientSdkKey: /* clientSdkKey */,
-  user
-});
-
-fp.start();
-```
-
-### Step 3. Use the instance to get your setting value
-
-You can use sdk to check which value this user will receive for a given feature flag.
-
-```js
-fp.on("ready", function() {
-  const result = fp.boolValue(/* toggleKey */, false);
-  if (result) {
-    // do_some_thing();
-  } else {
-    // do_other_thing();
-  }
-  const reason = fp.boolDetail(/* toggleKey */, false);
-  console.log(reason);
-})
-```
-
-### Step 4. Unit Testing (Optional)
-NPM:
-
-```js
-test("feature probe unit testing", (done) => {
-  let fp = FeatureProbe.newForTest({ testToggle: true });
-  fp.start();
-
-  fp.on("ready", function () {
-    let t = fp.boolValue(/* toggleKey */, false);
-    expect(t).toBe(true);
-    done();
-  });
-});
-```
-
-Or via CDN:
-
-```js
-test("feature probe unit testing", (done) => {
-  let fp = featureProbe.FeatureProbe.newForTest({ testToggle: true });
-  fp.start();
-
-  fp.on("ready", function () {
-    let t = fp.boolValue(/* toggleKey */, false);
-    expect(t).toBe(true);
-    done();
-  });
-});
-```
-
-## Available options
-
-This SDK takes the following options:
-
-| option            | required       | default | description                                                                                                                                      |
-|-------------------|----------------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------|
-| user              | yes            | n/a     | The User with attributes like name, age is used when toggle evaluation |
-| clientSdkKey      | yes            | n/a     | The Client SDK Key is used to authentification   |
-| remoteUrl         | depends | n/a     | The unified URL to get toggles and post events |
-| togglesUrl        | no             | n/a     | The specific URL to get toggles, once set, remoteUrl will be ignored |
-| eventsUrl         | no             | n/a     | The specific URL to post events, once set, remoteUrl will be ignored |
-| refreshInterval   | no            | 1000    | The SDK check for updated in millisecond   |
-
-## Testing
-
-We have unified integration tests for all our SDKs. Integration test cases are added as submodules for each SDK repo. So
-be sure to pull submodules first to get the latest integration tests before running tests.
-
-```js
-npm run test
-```
+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)
 
 ## Contributing