From 3142092726edd6de091ef9e59260d3722f23f7ca Mon Sep 17 00:00:00 2001
From: Tizen Ye <yzs981130@126.com>
Date: Mon, 6 Jul 2020 10:56:53 +0800
Subject: [PATCH] add docs

---
 README.md | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 3050a13..04d85f6 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,9 @@
 # Pod Lifecycle Logger
 
+## documentation
+
+通过定期轮询k8s中的活跃pod，再轮询k8s的metrics相关endpoint`apis/metrics.k8s.io/v1beta1/namespaces/default/pods`，获取到当前集群中所有活跃pods的CPU和memory使用情况，并通过与上一次记录比较，将更新的内容记录下来。最终持久化到log中。
+
 ## dependency
 
 需要k8s具有`metrics.k8s.io`的metrics API
@@ -12,5 +16,5 @@
 
 ## image
 
-`docker pull yzs981130/podlifecyclelogger:version-0.0.2`
+`docker pull yzs981130/podlifecyclelogger:version-0.0.3`