shcp-api-lib 1.0.0

package/README.md

@@ -0,0 +1,74 @@
+# SHCP Model Library
+
+这是一个包含 SHCP 项目所有数据模型、常量和 API 的 TypeScript 库。
+
+## 安装
+
+```bash
+npm install @shcp/model-lib
+```
+
+## 使用
+
+### 使用模型
+
+```typescript
+import { ConsumerModel, DeviceModel } from '@shcp/model-lib'
+
+// 使用模型
+const consumer = new ConsumerModel()
+const device = new DeviceModel()
+```
+
+### 使用常量
+
+```typescript
+import { ShcpUserType, ClientType, Gender, MessageStatus } from '@shcp/model-lib'
+
+// 使用枚举
+const userType = ShcpUserType.Consumer
+const clientType = ClientType.CApp
+const gender = Gender.Male
+const messageStatus = MessageStatus.Unread
+```
+
+### 使用 API
+
+```typescript
+import { consumerApi, deviceApi, healthMetricApi } from '@shcp/model-lib'
+
+// 使用 API
+const getConsumerList = async () => {
+  const result = await consumerApi.list()
+  return result
+}
+
+const getDeviceList = async () => {
+  const result = await deviceApi.list()
+  return result
+}
+
+const getHealthMetrics = async () => {
+  const result = await healthMetricApi.list()
+  return result
+}
+```
+
+## 开发
+
+```bash
+# 安装依赖
+npm install
+
+# 开发模式
+npm run dev
+
+# 构建
+npm run build
+```
+
+## 发布
+
+```bash
+npm publish
+```