write README.md

majian159 · Sep 3, 2021 · 3a415f5 · 3a415f5
1 parent 8ad3164
commit 3a415f5
Show file tree

Hide file tree

Showing 14 changed files with 70 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,70 @@
-# kubelemon
+# KubeLemon
+
+# Getting Started
+
+## Prerequisites
+
+- [KubeVela](https://kubevela.io/docs/install)
+
+## Quickstart
+
+1. Start apiserver:
+   ```sh
+   make run-apiserver
+   ```
+2. Start dashboard:
+   ```sh
+   make run-dashboard
+   ```
+- The api swagger will be served at http://localhost:8080/swagger/
+- The dashboard will be served at http://localhost:8000
+
+# To-do
+
+- Namespaces support
+- More Component/Trait forms
+- Provide Trait/Component forms as plugins
+- Metric chart
+- More...
+
+# Screenshot
+
+## Application
+
+### Application List
+
+![](doc/images/applications.png)
+
+### Application Create
+
+![](doc/images/applications_create.png)
+
+### Application Edit
+
+![](doc/images/applications_edit.png)
+
+![](doc/images/applications_edit_component_1.png)
+
+![](doc/images/applications_edit_component_2.png)
+
+![](doc/images/applications_edit_component_3.png)
+
+![](doc/images/applications_edit_component_4.png)
+
+![](doc/images/applications_edit_component_5.png)
+
+## Clusters
+
+### Cluster List
+
+![](doc/images/clusters.png)
+
+![](doc/images/clusters_create.png)
+
+![](doc/images/clusters_edit.png)
+
+![](doc/images/clusters_delete.png)
+
+## OpenAPI
+
+![](doc/images/openapi.png)
diff --git a/doc/images/applications.png b/doc/images/applications.png
diff --git a/doc/images/applications_create.png b/doc/images/applications_create.png
diff --git a/doc/images/applications_edit.png b/doc/images/applications_edit.png
diff --git a/doc/images/applications_edit_component_1.png b/doc/images/applications_edit_component_1.png
diff --git a/doc/images/applications_edit_component_2.png b/doc/images/applications_edit_component_2.png
diff --git a/doc/images/applications_edit_component_3.png b/doc/images/applications_edit_component_3.png
diff --git a/doc/images/applications_edit_component_4.png b/doc/images/applications_edit_component_4.png
diff --git a/doc/images/applications_edit_component_5.png b/doc/images/applications_edit_component_5.png
diff --git a/doc/images/clusters.png b/doc/images/clusters.png
diff --git a/doc/images/clusters_create.png b/doc/images/clusters_create.png
diff --git a/doc/images/clusters_delete.png b/doc/images/clusters_delete.png
diff --git a/doc/images/clusters_edit.png b/doc/images/clusters_edit.png
diff --git a/doc/images/openapi.png b/doc/images/openapi.png