From 2492903cebc3db6d178b446c411bbe51d4670564 Mon Sep 17 00:00:00 2001
From: Cairry <115769353+Cairry@users.noreply.github.com>
Date: Fri, 27 Dec 2024 15:32:13 +0800
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=84=20Update=20README=20docs=20file?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 deploy/README.md => README.md | 47 ++++++++++++++++++++++++++++-------
 1 file changed, 38 insertions(+), 9 deletions(-)
 rename deploy/README.md => README.md (62%)

diff --git a/deploy/README.md b/README.md
similarity index 62%
rename from deploy/README.md
rename to README.md
index 68ef378..3dee4c4 100644
--- a/deploy/README.md
+++ b/README.md
@@ -1,5 +1,27 @@
-# 运行 WatchLog
-## 确定参数配置
+WatchLog
+========
+## 🎉 项目介绍
+`WatchLog`是一个云原生容器日志采集工具。你可以使用它来收集`Docker`、`Containerd`的容器日志并发送到集中式日志管理系统中，例如`elasticsearch` `kafka` `redis`等。
+
+## ♻️ 版本兼容
+
+**Input**
+
+| Service    | Version    |
+|------------|------------|
+| Docker     | 推荐 20.x ➕  |
+| Containerd | 推荐 1.2.x ➕ |
+
+**Output**
+
+| Service       | Version      |
+|---------------|--------------|
+| Elasticsearch | 推荐 7.10.x ➕  |
+| Kafka         | 推荐 2.x ➕     |
+| Redis         | 推荐 6.x ➕     |
+
+## 🚀 快速开始
+### 确定参数配置
 - LOG_PREFIX：日志前缀标识, 默认是watchlog, 支持自定义
 - LOG_BASE_DIR：日志存储目录（挂载到WatchLog容器内的路径），默认 `/host/var/log/pods`
 - RUNTIME_TYPE：运行时类型，支持`docker` `containerd`
@@ -61,20 +83,27 @@
             - name: FILE_NAME
               value: "filebeat"
 ```
-## 启动服务
+### 启动服务
 ```bash
-kubectl apply -f ./kubernetes/watchlog.yaml
+kubectl apply -f ./deploy/kubernetes/watchlog.yaml
 ```
 
-# 运行测试用例
-## 前提条件
+### 运行测试用例
+#### 前提条件
 需要为每个被收集的`Controller`/`Pod`中, 注入日志采集前缀标志`watchlog_{xxx}`的环境变量, 前缀标识取决于 WatchLog 服务的环境变量 LOG_PREFIX, 默认情况下是 watchlog.
 ```yaml
         - env:
             - name: watchlog_default-nginx
               value: stdout
 ```
-## 启动服务
+#### 启动服务
 ```bash
-kubectl apply -f ./kubernetes/nginx.yaml
-```
\ No newline at end of file
+kubectl apply -f ./deploy/kubernetes/nginx.yaml
+```
+
+## 🎸 支持
+- 如果你觉得 WatchLog 还不错，可以通过 Star 来表示你的喜欢
+- 在公司或个人项目中使用 WatchLog，并帮忙推广给伙伴使用
+
+## 🧑‍💻 交流渠道
+- [点击我](https://cairry.github.io/docs/#%E4%BA%A4%E6%B5%81%E7%BE%A4-%E8%81%94%E7%B3%BB%E6%88%91)
\ No newline at end of file