Specification NestOS Project Component Description File

Signed-off-by: duyiwei <duyiwei@kylinos.cn>

README.md

@@ -1,30 +1,39 @@
 # zincati
 
 #### 介绍
-Zincati is an auto-update agent for NestOS hosts..
+Zincati is an auto-update agent for NestOS hosts.
 
-#### 软件架构
+It works as a client for Cincinnati and rpm-ostree, taking care of automatically updating/rebooting machines.
-软件架构说明
+
+#### Features:
+-Agent for continuous auto-updates, with support for phased rollouts
+-Configuration via TOML dropins and overlaid directories
+-Multiple update strategies for finalization/reboot
+-Local maintenance windows on a weekly schedule for planned upgrades
+-Internal metrics exposed over a local endpoint in Prometheus format
+-Logging with configurable priority levels
+-Support for complex update-graphs via Cincinnati protocol (with rollout wariness, barriers, dead-ends and more)
+-Support for cluster-wide reboot orchestration, via an external lock-manager
 
 
 #### 安装教程
 
-1.  xxxx
+Install zincati rpm package:
-2.  xxxx
+
-3.  xxxx
+yum install zincati
 
 #### 使用说明
 
-1.  xxxx
+详细使用说明请参考[zincati官网](https://coreos.github.io/zincati/)以及[NestOS主页](https://gitee.com/openeuler/NestOS)
-2.  xxxx
-3.  xxxx
 
 #### 参与贡献
 
-1.  Fork 本仓库
+master分支使用最新的上游版本，如果检测到上游有最新版本发布，先形成issue后再提交对应PR更新，流程如下。
-2.  新建 Feat_xxx 分支
+1.  提交issue
-3.  提交代码
+2.  Fork 本仓库
-4.  新建 Pull Request
+3.  新建 Feat_xxx 分支
+4.  提交代码
+5.  新建 Pull Request
 
 
 #### 特技