feat: update readme.md and remove the archive and profile directory

KusionStack · Nov 22, 2024 · 773a26e · 773a26e
2 parents c141405 + 9ec6dc0
commit 773a26e
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 81 deletions.
diff --git a/README.md b/README.md
@@ -1,19 +1,16 @@
-# .github
-
-* [Overview](#overview)
-* [GitHub files](#github-files)
-* [Contributing](#contributing)
+# kusion-api-go
 
 ## Overview
 
-This repository stores
-[default GitHub template files](https://help.github.com/en/articles/creating-a-default-community-health-file-for-your-organization).
-These files apply to all other KusionStack repositories that do not have
-their own versions in their `.github/` directory.
+This repository stores the API definitions used by the core components of Kusion. 
+
+## Purpose
+
+This library is published separately to avoid circular dependency and diamond dependency problems for users who depend on more than one of `kusionstack.io/kusion`, `kusionstack.io/kusion-module-framework` and `kusionstack.io/catalog`, etc. 
 
-## GitHub files
+## Where does this repo come from? 
 
-See [our `.github` documentation](.github/README-templates.md).
+`kusion-api-go` is synced from [https://github.com/KusionStack/kusion/tree/main/pkg/apis](https://github.com/KusionStack/kusion/tree/main/pkg/apis). Code changes will be first made in `kusion` and later synced into this repository. The tag versions of `kusion-api-go` are compatible with `kusion` since `v0.13.0`. 
 
 ## Contributing
 

diff --git a/archive/CLA.md b/archive/CLA.md
diff --git a/archive/CLA.png b/archive/CLA.png
diff --git a/profile/README.md b/profile/README.md
diff --git a/profile/kusionstack.png b/profile/kusionstack.png