'Release Documentation '

unionai · Jan 10, 2022 · d785c42 · d785c42
1 parent 68f20be
commit d785c42
Showing 1 changed file with 34 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,34 @@
-# uctl
-A cross platform CLI for unionai
+<html>
+    <h1 align="center">
+        UCtl
+    </h1>
+    <p align="center">
+       A cross platform CLI for unionai
+    </p>
+    <h3 align="center">
+        <a href="https://uctl.rtfd.io">Documentation</a>
+    </h3>
+</html>
+
+[![Docs](https://readthedocs.org/projects/uctl/badge/?version=latest&style=plastic)](https://uctl.rtfd.io)
+[![Current Release](https://img.shields.io/github/release/unionai/uctl.svg)](https://github.com/unionai/uctl/releases/latest)
+[![License](https://img.shields.io/badge/LICENSE-Apache2.0-ff69b4.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
+[![Slack](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://slack.union.ai)
+
+UCtl was designed as a portable and lightweight command-line interface to work with Unionai Cluster.
+
+## 🚀 Quick Start
+
+1. Install UCtl with bash or shell script
+
+    * Shell script
+        ```bash
+        $ curl -sL https://raw.githubusercontent.com/unionai/uctl/main/install.sh | bash
+        ```
+
+<html>
+    <h2 id="file-an-issue">
+        🐞 File an Issue
+    </h2>
+</html>
+