add docs

yzs981130 · Jul 6, 2020 · 744a8aa · 744a8aa
1 parent cb14ca0
commit 744a8aa
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,5 +1,8 @@
 # Pod Event Logger
 
+## documentation
+
+通过轮询k8s中的event endpoint`api/v1/namespaces/default/events`，只将发生了更新的event记录下来，并持久化写入log中。
 
 ## usage
 
@@ -9,5 +12,5 @@
 
 ## image
 
-`docker pull yzs981130/podeventlogger:version-0.0.2`
+`docker pull yzs981130/podeventlogger:version-0.0.3`