From 5c990464eec20bef2390208f11a849f3873aad1d Mon Sep 17 00:00:00 2001
From: Mingchen Dai <daimingchen@mail.ustc.edu.cn>
Date: Tue, 10 Sep 2024 08:28:12 +0000
Subject: [PATCH] Added README.md

---
 README.md | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 2fbaeda..fe5e910 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,12 @@
 # devstar-devcontainer-kubebuilder-scaffold
-// TODO(user): Add simple overview of use/purpose
+
+DevStar DevContainer CRD 脚手架工程
 
 ## Description
-// TODO(user): An in-depth paragraph about your project and overview of use
+
+本工程是 DevStar Studio 项目的子工程，专用于定制 k8s CRD (Custom Resource Definition) 资源及其自定义 Controller
+- **CRD 封装**：将 StatefulSet, Service, Ingress 打包部署
+- **Self-Healing**：当 DevContainer 意外终止或运维人员意外删库，该组件能够自动重新拉起对应的资源，保证服务的持续交付
 
 ## Getting Started