cesium-xs-sdk 1.0.0

package/README.md

@@ -0,0 +1,104 @@
+# cesium-xs-sdk
+
+基于 [Cesium 1.137](https://cesium.com/) 封装的轻量级三维 GIS SDK。
+
+> 目标：让 Cesium 常用能力（图层、标绘、事件、编辑）更易用、更统一。
+
+## 安装
+
+### 外网项目（npm）
+
+```bash
+npm install cesium-xs-sdk cesium
+```
+
+### 内网项目（离线包）
+
+从 [Gitee Release](https://gitee.com/d1564427109/cesium-xs-sdk/releases) 下载 `cesium-xs-sdk-v{x.x.x}-offline.zip`，解压后复制到项目。
+
+## 快速开始
+
+### HTML / script 标签
+
+```html
+<link rel="stylesheet" href="Cesium-1.137/Build/Cesium/Widgets/widgets.css" />
+<script src="Cesium-1.137/Build/Cesium/Cesium.js"></script>
+<script src="xs3d/cesium-xs-sdk.umd.js"></script>
+
+<script>
+  const sdk = xs3d.init('cesiumContainer', {
+    cesiumToken: 'your-ion-token'
+  });
+
+  sdk.graphicModule.createPoint('p1')
+    .setPosition([116.4, 39.9, 0])
+    .setColor(Cesium.Color.RED);
+</script>
+```
+
+### Vue 3
+
+```js
+import { useXs3d } from 'cesium-xs-sdk/vue';
+
+const { sdk, sceneModule, graphicModule, isReady } = useXs3d('cesiumContainer', {
+  cesiumToken: 'your-token'
+});
+```
+
+### Vue 2
+
+```js
+import { useXs3d } from 'cesium-xs-sdk/vue2';
+
+export default {
+  setup() {
+    const { sdk, sceneModule, graphicModule } = useXs3d('cesiumContainer', {
+      cesiumToken: 'your-token'
+    });
+    return { sdk, sceneModule, graphicModule };
+  }
+};
+```
+
+### React
+
+```jsx
+import { useXs3d } from 'cesium-xs-sdk/react';
+
+function Map() {
+  const { sdk, isReady } = useXs3d('cesiumContainer', {
+    cesiumToken: 'your-token'
+  });
+  return <div id="cesiumContainer" style={{ width: '100%', height: '100%' }} />;
+}
+```
+
+## 构建产物
+
+```text
+dist/
+├── cesium-xs-sdk.esm.js    # ES Module（Vite / Vue3 / 现代构建工具）
+├── cesium-xs-sdk.cjs.js    # CommonJS（Node / SSR）
+├── cesium-xs-sdk.umd.js    # UMD / 全局变量 xs3d（HTML / script 标签）
+└── cesium-xs-sdk.d.ts      # TypeScript 类型声明
+```
+
+## 核心模块
+
+| 模块 | 说明 |
+|------|------|
+| `SceneModule` | 影像/地形/3D Tiles 图层、坐标转换、相机定位 |
+| `GraphicModule` | 点、线、面、模型、文字、标绘图元创建与管理 |
+| `EventModule` | 鼠标、键盘、场景事件订阅与发布 |
+| `EditorModule` | 绘制、编辑、选择、删除等交互工具 |
+
+## 文档
+
+- [SDK 开发指南](../CLAUDE.md)
+- [军事标绘集成计划](docs/military-plot-sdk-integration-plan.md)
+- [变更记录](docs/change-log/)
+
+## 许可证
+
+MIT © 成都玄宿科技有限公司