Browse Source

core 1.0.1

gemercheung 3 years ago
parent
commit
7f257c5a4b
2 changed files with 43 additions and 1 deletions
  1. 37 0
      packages/core/README.md
  2. 6 1
      packages/core/package.json

+ 37 - 0
packages/core/README.md

@@ -0,0 +1,37 @@
+# Simaq
+> 录屏相关SDK, 代号司马迁,中国历史上最伟大的记录学家。
+
+# @Simaq/core
+
+录屏核心SDK
+
+## npm私服地址 http://192.168.0.47:4873/-/web/detail/@simaq/core
+
+
+## Installation
+
+```bash
+npm install @Simaq/core
+```
+
+
+## Usage
+
+```bash
+import { VideoRecorder } from '@simaq/core';
+
+const videoRecorder = new VideoRecorder({
+    uploadUrl: '',
+    resolution: '4k',
+    autoDownload: true,
+    debug: true, // 是否调试,
+});
+// 开始录屏
+const handlerStartRecord = videoRecorder.startRecord;
+// 停止录屏
+const handlerEndRecord = videoRecorder.endRecord;
+
+#  <button type="button" @click="videoRecorder.startRecord">开始录屏</button>
+#  <button type="button" @click="videoRecorder.endRecord">停止录屏</button>
+
+```

+ 6 - 1
packages/core/package.json

@@ -1,11 +1,16 @@
 {
   "name": "@simaq/core",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "main": "dist/index",
   "types": "dist/index",
   "files": [
     "dist"
   ],
+  "author": {
+    "name": "gemercheung",
+    "email": "gemercheung@gmail.com",
+    "url": "http://gemer.xyz/"
+  },
   "scripts": {
     "build": "pnpm run clean && pnpm run compile",
     "clean": "rimraf -rf ./dist",