mm_expand 1.8.6 → 1.8.8

package/README.md

@@ -1,28 +1,50 @@
 # mm_expand
 
-这是超级美眉原型函数拓展模块，为JavaScript原生类型（String、Array、Number、Date等）提供丰富的拓展方法，使开发者能够更便捷地操作数据，简化业务逻辑，提高开发效率。
+[![npm version](https://badge.fury.io/js/mm_expand.svg)](https://www.npmjs.com/package/mm_expand)
+[![npm downloads](https://img.shields.io/npm/dt/mm_expand.svg)](https://www.npmjs.com/package/mm_expand)
+
+mm_expand是一个功能丰富的JavaScript工具库，为原生类型（String、Array、Number、Date等）提供全面的原型函数扩展，帮助开发者简化数据操作，提高代码效率和可维护性。
+
+## 特点
+
+- 丰富的原生类型扩展方法
+- 简化文件系统操作
+- 强大的对象处理功能
+- 灵活的事件系统
+- 轻量级且高性能
+- 跨平台兼容
 
 ## 安装
 
 ```bash
-npm install mm_expand
+npm install mm_expand --save
 ```
 
-## 使用方法
+## 快速开始
 
 ```javascript
 // 引入模块
 const $ = require('mm_expand');
 
-// 开始使用拓展方法
-$.log.debug('test.json'.fullname());
-$.log.debug([1, 2, 3].copy());
-$.log.debug('2024-01-01'.toTime());
+// 使用字符串扩展方法
+const fullPath = 'test.json'.fullname(); // 获取完整路径
+
+// 使用数组扩展方法
+const newArray = [1, 2, 3].copy(); // 复制数组
+
+// 使用日期扩展方法
+const date = '2024-01-01'.toTime(); // 转换为Date对象
+
+// 使用事件系统
+$.eventer.on('event', (data) => {
+  console.log(data);
+});
+$.eventer.run('event', { message: 'Hello' });
 ```
 
-## 核心功能模块
+## API文档
 
-### 基础工具函数
+### 全局工具函数
 
 #### $.info(obj)
 - 描述：获取函数或对象的详细信息，用于调试和开发
@@ -346,23 +368,27 @@ await $.sleep(2000, obj, 'ok');
 
 ## 最佳实践
 
-1. **文件路径处理**：使用`String.prototype.fullname()`获取完整路径，确保跨平台兼容性
-2. **错误处理**：所有文件操作（saveText、saveJson等）都返回布尔值表示成功/失败，建议检查返回值
+1. **文件路径处理**：始终使用`String.prototype.fullname()`获取完整路径，确保跨平台兼容性
+2. **错误处理**：检查所有文件操作（saveText、saveJson等）的返回值，它们都返回布尔值表示成功/失败
 3. **异步操作**：对于需要等待的操作，如sleep、事件触发等，使用await/async语法
 4. **对象深拷贝**：使用`$.copy()`进行对象深拷贝，避免引用问题
-5. **事件管理**：使用$.eventer系统进行事件发布订阅，避免直接函数调用导致的耦合
+5. **事件管理**：使用$.eventer系统进行事件发布订阅，降低代码耦合度
+6. **性能优化**：处理大量数据时，优先使用异步方法避免阻塞主线程
+
+## 兼容性
+
+- Node.js 10.x及以上版本
+- 支持所有现代浏览器（通过打包工具使用）
 
-## 注意事项
+## 贡献指南
 
-1. 所有文件路径操作都支持跨平台，内部会自动处理路径分隔符
-2. 文件操作相关函数已添加错误处理，返回布尔值表示操作结果
-3. 在处理大量数据时，建议使用异步方式避免阻塞主线程
-4. 原型扩展可能与其他库冲突，使用时请注意命名空间隔离
+欢迎提交Issue和Pull Request！请确保您的代码遵循项目的编码规范。
 
 ## 许可证
 
-ISC License
+[ISC License](LICENSE)
 
-## 作者
+## 联系作者
 
-qww
+- GitHub: [https://github.com/](https://github.com/)
+- Gitee: [https://gitee.com/qiuwenwu91/mm_expand](https://gitee.com/qiuwenwu91/mm_expand)