parse-pinyin 0.0.1 → 1.0.0

package/README.md

@@ -0,0 +1,174 @@
+根据您提供的信息，您的包名称为 `parse-pinyin`。我已经注意到在 `package.json` 中名称已经正确设置为 `"parse-pinyin"`。
+
+让我为您更新 `README.md` 文件以匹配正确的包名：
+
+```markdown
+# parse-pinyin
+
+[![NPM version](https://img.shields.io/npm/v/parse-pinyin.svg?style=flat-square)](https://npmjs.org/package/parse-pinyin)
+[![NPM downloads](https://img.shields.io/npm/dm/parse-pinyin.svg?style=flat-square)](https://npmjs.org/package/parse-pinyin)
+[![License](https://img.shields.io/npm/l/parse-pinyin.svg?style=flat-square)](https://github.com/your-username/parse-pinyin/blob/main/LICENSE)
+
+一个高效的汉字拼音查询库，使用极致优化的 JSON 格式存储拼音数据，支持多种输出格式和反向查询功能。
+
+## 特性
+
+- 🚀 **高性能**: 预处理数据结构，查询速度快
+- 📦 **轻量级**: 无外部依赖，包体积小
+- 🌐 **多格式支持**: 支持声调符号、数字声调、数组格式等多种输出
+- 🔁 **双向查询**: 支持汉字查拼音和拼音查汉字
+- 📱 **跨平台**: 支持 Node.js、浏览器和 Webpack/Vite 等构建工具
+
+## 安装
+
+```bash
+npm install parse-pinyin
+```
+
+## 快速开始
+
+```javascript
+import { toPinyin, toHanzi } from 'parse-pinyin';
+
+// 汉字转拼音 (默认格式 - 带声调符号)
+console.log(toPinyin('中')); 
+// 输出: ["zhōng", "zhòng"]
+
+// 汉字转拼音 (数字声调格式)
+console.log(toPinyin('中', { toneType: 'number' })); 
+// 输出: ["zhong1", "zhong4"]
+
+// 汉字转拼音 (数组格式)
+console.log(toPinyin('中', { toneType: 'array' })); 
+// 输出: [["zhong", 1], ["zhong", 4]]
+
+// 汉字转拼音 (无音调格式)
+console.log(toPinyin('中', { tone: false })); 
+// 输出: ["zhong", "zhong"]
+
+// 拼音反查汉字
+console.log(toHanzi('xíng')); 
+// 输出: ["行", "形", "型", ...]
+```
+
+## API 参考
+
+### `toPinyin(char: string, options?: ToneOptions)`
+
+将汉字转换为拼音
+
+#### 参数
+
+- `char`: 要查询的汉字 (单个字符)
+- `options`: 音调选项
+  - `tone`: 是否保留音调 (默认: `true`)
+  - `toneType`: 音调表示方式
+    - `'symbol'`: 声调符号 (默认)
+    - `'number'`: 数字声调
+    - `'array'`: 数组格式 `[拼音, 声调数字]`
+
+#### 返回值
+
+- 带音调符号: `string[]`
+- 数字声调: `string[]`
+- 数组格式: `(string | [string, number])[]`
+
+### `toHanzi(pinyin: string)`
+
+根据拼音查询匹配的汉字
+
+#### 参数
+
+- `pinyin`: 要查询的拼音
+
+#### 返回值
+
+- `string[]`: 匹配的汉字数组
+
+## 使用示例
+
+```javascript
+import { toPinyin, toHanzi } from 'parse-pinyin';
+
+// 基本使用
+console.log(toPinyin('你好世界'));
+// 输出: ["nǐ", "hǎo", "shì", "jiè"]
+
+// 多音字处理
+console.log(toPinyin('中'));
+// 输出: ["zhōng", "zhòng"]
+
+// 不同输出格式
+console.log(toPinyin('中', { toneType: 'number' }));
+// 输出: ["zhong1", "zhong4"]
+
+console.log(toPinyin('中', { toneType: 'array' }));
+// 输出: [["zhong", 1], ["zhong", 4]]
+
+console.log(toPinyin('中', { tone: false }));
+// 输出: ["zhong", "zhong"]
+
+// 拼音反查汉字
+console.log(toHanzi('zhong'));
+// 输出: ["中", "忠", "钟", "终", "种", "踵", "盅", "衷", "冢", "柊", ...]
+```
+
+## 性能对比
+
+在典型的使用场景中，parse-pinyin 相比其他拼音库具有以下优势：
+
+| 特性 | parse-pinyin | @napi-rs/pinyin |
+|------|--------------|-----------------|
+| 性能 | 高 | 更高 |
+| 依赖 | 无 | 需要原生模块 |
+| 包体积 | 小 | 大 |
+| 浏览器支持 | 完全支持 | 有限支持 |
+| 输出格式 | 多种格式 | 基本格式 |
+
+## 浏览器使用
+
+```html
+<script src="https://unpkg.com/parse-pinyin@latest/dist/index.global.js"></script>
+<script>
+  console.log(pinyin.toPinyin('中')); // ["zhōng", "zhòng"]
+  console.log(pinyin.toHanzi('xíng')); // ["行", "形", "型", ...]
+</script>
+```
+
+## Node.js 使用
+
+```javascript
+const { toPinyin, toHanzi } = require('parse-pinyin');
+
+console.log(toPinyin('中')); // ["zhōng", "zhòng"]
+console.log(toHanzi('xíng')); // ["行", "形", "型", ...]
+```
+
+## 构建和开发
+
+```bash
+# 安装依赖
+npm install
+
+# 构建项目
+npm run build
+
+# 运行测试
+npm test
+
+# 运行基准测试
+npm run bench
+```
+
+## 数据来源
+
+拼音数据来源于 CC-CEDICT 词典，经过预处理和优化以适应高性能查询需求。
+
+## 许可证
+
+MIT
+
+## 贡献
+
+欢迎提交 Issue 和 Pull Request 来改进这个项目！
+```