Browse Source

update doc

gemercheung 3 years ago
parent
commit
5ee9aaf520
1 changed files with 25 additions and 28 deletions
  1. 25 28
      README.md

+ 25 - 28
README.md

@@ -1,6 +1,6 @@
 # 埋点 SDK (代号:medici)
 # 埋点 SDK (代号:medici)
 
 
-> medici,美地奇,指Lorenzo Medici,洛伦佐·美第奇,美地奇家族 文艺复兴时伟大收藏家,亦是现代最大收集/收藏的家族之一。
+> medici,美地奇,指 Lorenzo Medici,洛伦佐·美第奇,美地奇家族 文艺复兴时伟大收藏家,亦是现代最大收集/收藏的家族之一。
 
 
 # browser (浏览器行为)
 # browser (浏览器行为)
 
 
@@ -14,12 +14,6 @@
 
 
 ## PV/UV 内置功能
 ## PV/UV 内置功能
 
 
-
-
-
-
-
-
 ## SDK 初始化 (monorepo)
 ## SDK 初始化 (monorepo)
 
 
 <!-- http://120.25.146.52:3090/mock/95/tracking/log/save -->
 <!-- http://120.25.146.52:3090/mock/95/tracking/log/save -->
@@ -27,26 +21,29 @@
 > 1.普通 es 引包
 > 1.普通 es 引包
 
 
 ```js
 ```js
-import * as medici from "@medici/web";
+import * as medici from '@medici/web';
 medici.init({
 medici.init({
-  url: "xxxxxx/tracking/log/save",
-  config: {
-    user: "xxxxxx",
-    version: "xxxxxxxx", //client version
-  },
+    platform: 'web',
+    appId: '7b5958d5-1ae6-4ad5-8a87-5fc8a4b92999',
+    endPoint: 'http://192.168.0.186:3000/api/collect', //服务器
+    trackEndPoint: 'http://192.168.0.186:3000/api/track',
+    config: {
+        user: 'testUser',//配置要track当前用户
+        version: '1', //配置要track当前版本
+    },
 });
 });
 ```
 ```
 
 
 > 2.小程序 es
 > 2.小程序 es
 
 
 ```js
 ```js
-import * as medici from "@medici/miniApp";
+import * as medici from '@medici/miniApp';
 medici.init({
 medici.init({
-  url: "xxxxxx/tracking/log/save",
-  config: {
-    user: "xxxxxx",
-    version: "xxxxxxxx", //client version
-  },
+    url: 'xxxxxx/tracking/log/save',
+    config: {
+        user: 'xxxxxx',
+        version: 'xxxxxxxx', //client version
+    },
 });
 });
 ```
 ```
 
 
@@ -55,11 +52,11 @@ medici.init({
 ```js
 ```js
 <script src="xxx/xxxx/medici-amd.js"></script>;
 <script src="xxx/xxxx/medici-amd.js"></script>;
 medici.init({
 medici.init({
-  url: "xxxxxx/tracking/log/save",
-  config: {
-    user: "xxxxxx",
-    version: "xxxxxxxx", //client version
-  },
+    url: 'xxxxxx/tracking/log/save',
+    config: {
+        user: 'xxxxxx',
+        version: 'xxxxxxxx', //client version
+    },
 });
 });
 ```
 ```
 
 
@@ -73,10 +70,10 @@ medici.init({
 
 
 ```js
 ```js
 medici.setPages([
 medici.setPages([
-  {
-    scene: "/scene",
-    setting: "/setting",
-  },
+    {
+        scene: '/scene',
+        setting: '/setting',
+    },
 ]);
 ]);
 ```
 ```