Add Readme (#48)

* Add README * Add information * Update the information
boundless-forest · Jan 18, 2024 · c5cb298 · c5cb298
1 parent adb581b
commit c5cb298
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,28 @@
-# Polkadot Cli
+# polkadot-cli
+
+This interactive CLI tool is designed for effortless interaction with Substrate-based chains, using the [polkadot-sdk](https://github.com/paritytech/polkadot-sdk). Its goal is to offer functionality akin to that of the Polkadot Apps.
+
+```sh
+$ polkadot-cli
+```
+
+![polkadot-cli](./resource/polkadot-cli.png)
+
+# Highlight Features
+
+1. Switch networks with a simple command
+
+    ```
+    $ app switch-network --network polkadot
+    ```
+
+2. App Dashboard to view the concrete runtime information, such as runtime version, pallet information.
+
+    ```sh
+    $ app dash-board
+    ```
+
+
+    ![app dashboard](./resource/dashboard.png)
+
+3. Command completion, try to type `usage` yourself.
diff --git a/resource/dashboard.png b/resource/dashboard.png
diff --git a/resource/polkadot-cli.png b/resource/polkadot-cli.png