diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..3e50c75113746387ec4df2506480f309d3c37035 --- /dev/null +++ b/README.en.md @@ -0,0 +1,57 @@ + + +# Watch-Project-Tool + +More convenient monitoring and command execution + +## Introduction + +This is a tool that monitors project file changes and automatically executes specified commands. It is suitable for real-time building, testing, and deployment scenarios in front-end development. + +## Main Features + +- File change monitoring +- Automatic command execution +- Multiple configuration support +- Cross-platform operation + +## Usage + +1. Install dependencies +2. Configure monitoring rules +3. Start the monitoring service + +## Example Configuration + +```javascript +// Example configuration code +const config = { + watchDir: './src', + command: 'npm run build', + extensions: ['.js', '.vue'] +}; +``` + +## Features + +- High-performance file system monitoring +- Support for various trigger conditions +- Extensible plugin system +- Detailed logging + +## Documentation + +For more usage instructions and API details, please refer to: +- [Markdown Examples](/markdown-examples) +- [API Examples](/api-examples) + +## Developer Tools + +The project includes the following developer tools: +- Configuration generator +- Command line interface +- Live reload server + +## License + +This project is released under the MIT License. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..ee281fb29fd61e6f950f496e055866bb64c1d705 --- /dev/null +++ b/README.md @@ -0,0 +1,55 @@ +# Watch-Project-Tool + +更方便监控并运行你想要的命令 + +## 简介 + +这是一个可以监控项目文件变化并自动执行指定命令的工具。适用于前端开发中的实时构建、测试和部署场景。 + +## 主要功能 + +- 文件变化监控 +- 自动命令执行 +- 多配置支持 +- 跨平台运行 + +## 使用方法 + +1. 安装依赖 +2. 配置监控规则 +3. 启动监控服务 + +## 示例配置 + +```javascript +// 示例配置代码 +const config = { + watchDir: './src', + command: 'npm run build', + extensions: ['.js', '.vue'] +}; +``` + +## 特性 + +- 高性能文件系统监控 +- 支持多种触发条件 +- 可扩展的插件系统 +- 详细的日志记录 + +## 文档 + +更多使用方法和API说明请参考: +- [Markdown Examples](/markdown-examples) +- [API Examples](/api-examples) + +## 开发者工具 + +项目包含以下开发者工具: +- 配置生成器 +- 命令行界面 +- 实时重载服务器 + +## 许可证 + +本项目采用 MIT 许可证。 \ No newline at end of file