@datarangers/sdk-javascript 0.0.1

package/LICENSE

@@ -0,0 +1,9 @@
+Beijing Volcano Engine Technology Co., Ltd.
+
+The DataRangers SDK was developed by Beijing Volcanoengine Technology Ltd. (hereinafter “Volcanoengine”). Any copyright or patent right is owned by and proprietary material of the Volcanoengine.
+
+DataRangers SDK is available under the Volcanoengine and licensed under the commercial license. Customers can contact service@volcengine.com for commercial licensing options. Here is also a link to subscription services agreement: https://www.volcengine.com/docs/6285/69647
+
+Without Volcanoengine's prior written permission, any use of DataRangers SDK, in particular any use for commercial purposes, is prohibited. This includes, without limitation, incorporation in a commercial product, use in a commercial service, or production of other artefacts for commercial purposes.
+
+Without Volcanoengine's prior written permission, the DataRangers SDK may not be reproduced, modified and/or made available in any form to any third party.

package/README.md

@@ -0,0 +1,48 @@
+English | [简体中文](./README.zh-CN.md)
+
+# `DataRangers SDK - javascript`
+## Sample
+
+```javascript
+npm install 
+npm run build
+```
+
+## Sample
+
+### 1. Initialize the SDK in your javascript file
+
+```javascript
+const SDK = require('@datarangers/sdk-javascript');
+
+SDK.init({
+  app_id: 1234, // Replace it with the "APP_ID"
+  channel: 'cn', // Replace it with your report channel
+  log: true, // Whether to print the log
+});
+
+SDK.config({
+  username: 'xxx', // when you want report username with event
+});
+
+SDK.start(); // Setup complete and now events can be sent.
+
+```
+
+### 2. Report custom user behavior events
+
+```javascript
+// Take reporting the "video clicked" behavior of users for example
+SDK.event('play_video', {
+  title: 'Here is the video title',
+});
+```
+
+### 3. Report the unique identifier of the currently logged in user
+
+```javascript
+// Set "user_unique_id" after a user logs in and the user's unique identifier is retrieved.
+ SDK.config({
+    user_unique_id: 'zhangsan', // Unique user identifier
+  });
+```

package/README.zh-CN.md

@@ -0,0 +1,47 @@
+简体中文 | [English](./README.md)
+# `DataRangers SDK - Web端`
+## 构建SDK
+
+```javascript
+npm install 
+npm run build
+```
+
+## 使用方式
+
+### 1. 在你的js文件中初始化SDK
+
+```javascript
+const SDK = require('@datarangers/sdk-javascript');
+
+SDK.init({
+  app_id: 1234, // 替换成你申请的 "APP_ID"
+  channel: 'cn', // 选择你要上报的区域，cn: 国内 sg: 新加坡 va:美东
+  log: true, // 是否打印日志
+});
+
+SDK.config({
+  username: 'xxx', // 你想要上报一个username的公共属性
+});
+
+SDK.start(); // 初始化完成，事件开始上报
+
+```
+
+### 2. 上报自定义用户事件
+
+```javascript
+// 比如上报一个'play_video'视频播放的事件
+SDK.event('play_video', {
+  title: 'Here is the video title',
+});
+```
+
+### 3. 使用当前登录用户的信息做为唯一标识来进行上报
+
+```javascript
+// 可以在用户登录后获取带有唯一性的标识来设置给user_unique_id
+ SDK.config({
+    user_unique_id: 'zhangsan', // 用户唯一标识，可以是你的系统登录用户id
+  });
+```