diff --git a/README.md b/README.md index 3140c09..11fb73e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # compress-gltf-tools -这是从当前仓库里提取出来的一个 Node 20+ 模型处理子项目,用来在 Node 环境里直接处理 glTF / GLB 资源。 +一个 Node 20+ 模型处理项目,用来在 Node 环境里直接处理 glTF / GLB 资源。 目前支持: @@ -13,22 +13,15 @@ ## 安装 ```bash -cd node-model-tools -npm install -``` - -## 构建 - -```bash -npm run build +npm install @g1sir8b/compress-gltf-tools ``` ## 基本用法 ```ts -import { processModel } from './dist'; +import { processModel } from '@g1sir8b/compress-gltf-tools'; -const result = await processModel('../demo/assets/building/task_building_6.gltf', { +const result = await processModel('/demo/assets/building/task_building_6.gltf', { rootDir: '..', outDir: './output', compress: { @@ -68,7 +61,7 @@ console.log(result.uploadFiles); 示例: ```ts -'../demo/assets/building/task_building_6.gltf' +'/demo/assets/building/task_building_6.gltf' ``` ### `options` @@ -102,7 +95,7 @@ rootDir: process.cwd() 例如输入: ```txt -../demo/assets/building/task_building_6.gltf + /demo/assets/building/task_building_6.gltf ``` 如果设置: diff --git a/package.json b/package.json index 65c3ee2..e9c12f6 100644 --- a/package.json +++ b/package.json @@ -1,8 +1,8 @@ { - "name": "compress-gltf-tools", + "name": "@g1sir8b/compress-gltf-tools", "version": "0.1.0", "private": true, - "description": "Node 20+ model processing toolkit extracted from seinjs-gltf-loader", + "description": "Node 20+ model processing toolkit", "main": "dist/index.js", "engines": { "node": ">=20"