@realsee/dnalogel 2.0.0-alpha.9 → 2.0.0-beta.36

package/README.md

@@ -1,50 +1,100 @@
-# 注意
-2.x 版本依赖 `svelte`， 使用时请同时安装 
-```bash
-npm install svelte 
-```
+<p align="center">
+	<a href="https://realsee.js.org/"><img src="https://vrlab-public.ljcdn.com/common/file/web/ea031fa5-ad82-46b3-86c8-7b20ec1e635a.jpg" width="60" /></a>
+</p>
 
-# 如视 -- "Dnalogel"
+<p align="center">
+  <a href="https://www.npmjs.com/package/@realsee/dnalogel">
+    <img src="https://img.shields.io/npm/v/@realsee/dnalogel.svg" alt="npm version" >
+  </a>
+  <a href="https://packagephobia.now.sh/result?p=@realsee/dnalogel">
+    <img src="https://packagephobia.now.sh/badge?p=@realsee/dnalogel" alt="install size" >
+  </a>
+  <a href="https://github.com/realsee-developer/dnalogel/blob/main/plugins/TERMS.txt">
+    <img src="https://img.shields.io/npm/l/@realsee/dnalogel.svg" alt="license">
+  </a>
+</p>
 
-[如视(realsee.com)](https://realsee.com) 提供了在浏览器环境中的渲染三维空间 [VR 看房 SDK Five](https://open-platform.realsee.com/developer/docs/front/3d-space/get-started/rendering-engine/) 。
-通过 [如视开放 API](https://open-platform.realsee.com/developer/open/api/#/) 并结合 Five 的渲染能力可以制作丰富多彩的三维空间应用。
+<h1 align="center">@realsee/dnalogel</h1>
 
-除了 Five 强大的三维空间渲染能力之外，我们也积累了大量的 **VR 看房** 常用功能，并以 `Five Plugins` 的形式进行抽象。
+# 👀 Overview
 
-无论是经过线上环境千锤百炼的刚需功能，还是灵感一现的炫酷尝试，凡是最终落地的功能我们均毫无保留的开源至 github [realsee-developer](https://github.com/realsee-developer) 空间。
+@realsee/dnalogel 将 [如视(realsee.com)](https://realsee.com) **VR 看房** 常用能力沉淀，并以 `Five Plugins` 形式进行抽象。
+结合[如视 VR 看房 SDK Five](https://open-platform.realsee.com/developer/docs/front/3d-space/get-started/rendering-engine/) 
+与 [如视开放 API](https://open-platform.realsee.com/developer/open/api/#/) ,可以制作出丰富多彩的三维空间应用。不论是经过线上环境千锤百炼的刚需功能，还是灵感一现的炫酷尝试，所有已经落地的功能我们均毫无保留的开源至github [realsee-developer/dnalogel](https://github.com/realsee-developer/dnalogel) 。
 
-如果插件满足您的需求，`npm install @realsee/dnalogel`一键安装使用。
+# 🔨 Usage
 
-如果不满足需求，没关系，把我们当作代码示例，我们抛砖引玉。
+**1、安装**
 
-我们也很期待您基于 [Three.js](https://threejs.org/) 、[Five.js](https://www.npmjs.com/package/@realsee/five) 等这类渲染库做出有意思的功能。
+```bash
+npm install @realsee/dnalogel
+```
 
+```bash
+yarn add @realsee/dnalogel
+```
 
-### 插件列表
-- ModelViewPlugin：模型小窗插件
-- PanoFloorplanRadarPlugin：全景户型雷达图插件
-- ModelRoomLabelPlugin：模型态房屋标签插件
-- TopviewFloorplanPlugin：俯视模型户型图插件
-- ModelChassisCompassPlugin：模型底盘指南针插件
-- ModelEntryDoorGuidePlugin：模型入户门引导插件
-- CSS3DRenderPlugin：CSS3D渲染插件
-- CameraMovementPlugin：相机运镜插件
-- ModelFloorplanPlugin：模型户型图插件
-- PanoRulerPlugin：全景标尺插件
-- PanoCompassPlugin：全景指南针插件
-- ... 待补充
+2.x 版本依赖 `svelte`， 使用时请同时安装:
+```bash
+npm install svelte 
+```
+
+```bash
+yarn add svelte 
+```
 
-### 使用方式
+**2、插件注册**
 
 ```js
 import { Five } from '@realsee/five'
-import Plugin from '@realsee/dnalogel/plugins/Plugin'
+import { Plugin } from '@realsee/dnalogel'
 const five = new Five({
   plugins: [[Plugin, 'PluginName', initOptions]],
 })
+```
+
+**3、插件方法使用**
 
+```js
 // 不同插件提供的方法可能存在差异,请参考各插件 API 文档
 five.plugins.PluginName.load(data)
 five.plugins.PluginName.enable()
 five.plugins.PluginName.disable()
+five.plugins.PluginName.dispose()
 ```
+
+**4、插件依赖数据获取**
+
+您可以通过 [open API](https://open-platform.realsee.com/developer/open/api#/) 查看数据获取方式及相关 open API 。
+
+# 📖 Documents
+
+- [说明文档](https://open-platform.realsee.com/developer/docs/front/3d-space/advanced/dnalogel/ModelViewPlugin/)
+- [API 文档](https://unpkg.com/@realsee/dnalogel/docs/index.html)
+- [demo 源码](https://github.com/realsee-developer/dnalogel/tree/main/examples/src)
+- [数据依赖来源：open API](https://open-platform.realsee.com/developer/open/api/)
+- [CHANGELOG](https://github.com/realsee-developer/dnalogel/blob/main/plugins/CHANGELOG.md)
+
+# 💡 Preview
+
+我们为每个插件书写了简单的效果示例，您可点击预览：
+[@realsee/dnalogel showcase](https://realsee.js.org/dnalogel/)
+
+
+# 🧾 Lists
+
+- 🔌 ModelViewPlugin：模型小窗插件
+- 🔌 PanoFloorplanRadarPlugin：全景户型雷达图插件
+- 🔌 ModelRoomLabelPlugin：模型态房屋标签插件
+- 🔌 TopviewFloorplanPlugin：俯视模型户型图插件
+- 🔌 ModelChassisCompassPlugin：模型底盘指南针插件
+- 🔌 ModelEntryDoorGuidePlugin：模型入户门引导插件
+- 🔌 CSS3DRenderPlugin：CSS3D渲染插件
+- 🔌 CameraMovementPlugin：相机运镜插件
+- 🔌 ModelFloorplanPlugin：模型户型图插件
+- 🔌 PanoRulerPlugin：全景标尺插件
+- 🔌 PanoCompassPlugin：全景指南针插件
+- 其他插件持续更新中...
+
+# License
+[TERMS](https://github.com/realsee-developer/dnalogel/blob/main/plugins/TERMS.txt)