Skip to content

Commit 486c279

Browse files
committed
feat: 修改README,将TODO描述改成使用建议。增加开源协议链接
1 parent 20868ef commit 486c279

File tree

2 files changed

+36
-28
lines changed

2 files changed

+36
-28
lines changed

README.md

Lines changed: 26 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,25 @@ A high-performance, configurable Go data processing pipeline library with suppor
1212

1313
## 🚀 Performance Metrics
1414

15-
- ✅ Reliably processes tens of billions of data entries daily
16-
- ⚡️ Handles hundreds of thousands of entries per second per instance
17-
- 💾 Controlled memory usage, supports large-scale distributed deployment
18-
- 🔥 Excellent performance in high-concurrency and big data scenarios
15+
- ✅ Reliably processes tens of billions of data entries daily
16+
- ⚡️ Handles hundreds of thousands of entries per second per instance
17+
- 💾 Controlled memory usage, supports large-scale distributed deployment
18+
- 🔥 Excellent performance in high-concurrency and big data scenarios
1919

2020
## ✨ Features
2121

22-
- 🎯 Generic support for processing any data type
23-
- 🔄 Provides both synchronous and asynchronous processing modes
24-
- 🎨 Data deduplication support
25-
- ⚙️ Configurable batch size and flush intervals
26-
- 🛡️ Built-in error handling and recovery mechanisms
27-
- 🎊 Graceful shutdown and resource release
22+
- 🎯 Generic support for processing any data type
23+
- 🔄 Provides both synchronous and asynchronous processing modes
24+
- 🎨 Data deduplication support
25+
- ⚙️ Configurable batch size and flush intervals
26+
- 🛡️ Built-in error handling and recovery mechanisms
27+
- 🎊 Graceful shutdown and resource release
2828

29-
- Production Environment Validation:
30-
- Stable operation with tens of billions of daily data entries
31-
- Single instance processes hundreds of thousands of entries per second
32-
- Controlled memory usage, supports large-scale distributed deployment
33-
- Excellent performance in high-concurrency and big data scenarios
29+
- Production Environment Validation:
30+
- Stable operation with tens of billions of daily data entries
31+
- Single instance processes hundreds of thousands of entries per second
32+
- Controlled memory usage, supports large-scale distributed deployment
33+
- Excellent performance in high-concurrency and big data scenarios
3434

3535
## Installation
3636

@@ -286,18 +286,18 @@ graph TB
286286
- Adjust based on real-time requirements
287287
- Smaller intervals improve real-time performance but increase processing overhead
288288

289-
## TODO
289+
## Usage Recommendations
290290

291291
1. Concurrency Control
292292

293-
- Implement goroutine pool to control concurrency
294-
- Prevent goroutine leaks under high load
293+
- Consider implementing goroutine pool to control concurrency
294+
- Take measures to prevent goroutine leaks under high load
295295

296-
2. Enhanced Error Handling
296+
2. Error Handling Enhancement
297297

298-
- Add error callback mechanism
299-
- Implement more comprehensive graceful shutdown
300-
- Provide batch processing status tracking
298+
- Consider adding error callback mechanism
299+
- Implement comprehensive graceful shutdown strategy
300+
- Consider adding batch processing status tracking
301301

302302
3. Performance Optimization
303303

@@ -313,3 +313,7 @@ graph TB
313313
- Add detailed logging
314314
- Integrate monitoring metrics export
315315
- Provide debugging interfaces
316+
317+
## License
318+
319+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

README_cn.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -286,18 +286,18 @@ graph TB
286286
- 根据实时性要求调整
287287
- 较小的间隔可提高实时性,但会增加处理开销
288288

289-
## TODO
289+
## 使用建议
290290

291291
1. 并发控制
292292

293-
- 实现 goroutine 池控制并发数量
294-
- 避免高负载下的 goroutine 泄露
293+
- 建议实现 goroutine 池以控制并发数量
294+
- 注意采取措施防止高负载下的 goroutine 泄露
295295

296296
2. 错误处理增强
297297

298-
- 添加错误回调机制
299-
- 实现更完善的优雅关闭功能
300-
- 提供批次处理状态追踪
298+
- 可以考虑添加错误回调机制
299+
- 建议实现完善的优雅关闭策略
300+
- 可以考虑添加批次处理状态追踪
301301

302302
3. 性能优化
303303

@@ -313,3 +313,7 @@ graph TB
313313
- 添加详细的日志记录
314314
- 集成监控指标导出
315315
- 提供调试接口
316+
317+
## 开源协议
318+
319+
本项目采用 MIT 开源协议 - 查看 [LICENSE](LICENSE) 文件了解详情。

0 commit comments

Comments
 (0)