From f3d4bb75d714696e39fcba8496c97bc4ddcaba74 Mon Sep 17 00:00:00 2001
From: BryantHe <bryantsisu@gmail.com>
Date: Mon, 5 Jun 2023 18:36:19 +0800
Subject: [PATCH] update readme

---
 README.md | 62 +++++++++++++++++++++++++++++++------------------------
 setup.py  |  2 +-
 2 files changed, 36 insertions(+), 28 deletions(-)

diff --git a/README.md b/README.md
index 90fea64..ca31d09 100644
--- a/README.md
+++ b/README.md
@@ -6,35 +6,43 @@ chassis <ˈʃæsi>  n. 底盘，底架
 
 ## 包含的特性
 
-1. 模板代码
+### 已包含
+
+- 模板代码
    - nameko 微服务
    - apiflask Web 服务
-   - rocketry 定时任务服务
-2. 事务
-   - 实现 Saga 模式
-3. 查询
-4. 高可用
-   1. 
-5. 可观测 Observability 
-   1. Metrics 
-       - Statsd + Prometheus + Grafana) 
-   2. Logging 
-       - ELK
-   3. Tracing 
-       - TODO, Maybe OpenTelemetry
-   4. Error Reporting
-       - Sentry
-6. 数据存储相关 utils
-   1. Sqlalchemy
-      - 连接池 
-      - 读写分离
-   2. Redis
-      - 连接池
-   3. ElasticSearch
-   4. 数据库迁移
-      - Alembic
-7. 服务注册和发现 (RabbitMQ)
-8. 配置获取 (TODO)
+   - rocketry 定时任务服务 
+- 服务注册和发现 (RabbitMQ)
+- 可观测 Observability
+   - Metrics 
+     - Statsd + Prometheus + Grafana
+   - Logging 
+     - fluentd + ELK
+   - Error Reporting
+     - Sentry
+- 数据存储相关 utils
+  - Sqlalchemy
+    - 连接池 
+    - 读写分离
+
+### TODO 
+
+- 可观测 Observability
+- Tracing 
+  - OpenTelemetry
+- 事务
+  - 基于开源库 DTM 实现 Saga 模式 
+- 高可用
+  - 重试
+  - 断路器
+- 数据存储相关 utils
+  - Sqlalchemy
+    - 数据库迁移
+      - Alembic 
+  - Redis
+    - 连接池
+  - ElasticSearch
+- 全局配置服务
 
 
 ## 实现的功能
diff --git a/setup.py b/setup.py
index f9ba03b..c5e8f43 100644
--- a/setup.py
+++ b/setup.py
@@ -9,7 +9,7 @@ with open(path.join(here, 'README.md'), encoding='utf-8') as f:
 
 setup(
     name='chassis',
-    version='0.0.3',
+    version='0.0.4',
     description='basic sdk',
     long_description=long_description,
     url='https://gitea.bearcatlog.com/BryantStudio/chassis',