From 801ddc8307bfb97c7b5feee97fab501781a5cf6c Mon Sep 17 00:00:00 2001
From: niusmallnan <niusmallnan@gmail.com>
Date: Thu, 6 May 2021 17:30:12 +0800
Subject: [PATCH] Update README

---
 README.md                | 18 +++++++++++++++++-
 scripts/tools/publish.sh |  0
 2 files changed, 17 insertions(+), 1 deletion(-)
 mode change 100644 => 100755 scripts/tools/publish.sh

diff --git a/README.md b/README.md
index 0eacce6..020e848 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,17 @@
-# kube-explorer
\ No newline at end of file
+# kube-explorer
+
+kube-explorer is portable explorer for Kubernetes, without any dependency.
+
+It integrates the Rancher steve framework and its dashboard, and is recompiled, packaged, compressed, and provides an almost completely stateless Kubernetes resource manager.
+
+## Usage ✅
+
+Please download the binary from the [release page](https://github.com/niusmallnan/kube-explorer/releases).
+
+To run an HTTP only server:
+
+```
+./kube-explorer --kubeconfig=xxxx --http-listen-port=9898 --https-listen-port=0
+```
+
+Then, open the browser to visit http://x.x.x.x:9898 .
diff --git a/scripts/tools/publish.sh b/scripts/tools/publish.sh
old mode 100644
new mode 100755