docs: add documents for pre-built binaries

Author: BewareMyPower

README.md

@@ -2,47 +2,69 @@
 
 The CLI tool to manage clusters on StreamNative Cloud.
 
-## Build
+## How to install
+
+### (Recommended) Use pre-built binaries
+
+Currently the release only supports macOS 14 or later with arm64 architecture.
+
+Take v0.1.0 for example:
+
+```bash
+export VERSION=0.1.0
+curl -O -L https://github.com/BewareMyPower/snctl-cpp/releases/download/v$VERSION/snctl-cpp-macos-14-arm64.zip
+unzip -q snctl-cpp-macos-14-arm64.zip
+./install.sh
+```
+
+The binary and configuration file will be installed under `~/.snctl-cpp`, so you have to add it to your `PATH`:
+
+```bash
+export PATH=$HOME/.snctl-cpp:$PATH
+```
+
+Now, you can run `snctl-cpp -h` to see the help message.
+
+### Build from source
 
 You must have a C++ compiler that supports C++17.
 
 ```bash
 git submodule update --init --recursive
 cmake -B build
 cmake --build build
+cp build/snctl-cpp .
 ```
 
-Then you can find the executable in `build/snctl-cpp`.
+You can run `./install.sh` to override the existing installation in `~/.snctl-cpp` directory, but you can also just run `./snctl-cpp` directly without installing it. The `sncloud.ini` file in the current working directory has higher priority than the one in `~/.snctl-cpp` directory.
 
-## How to use
+## How to manage topics in the cluster that enables Kafka protocol
 
 **Please make sure the `sncloud.ini` file is in the current working directory or `~/.snctl-cpp` directory if you don't specify the `--config` option.**
 
 You only need to fill the following fields in `sncloud.ini`:
 - `bootstrap.servers`: the URL of the Kafka service, e.g. `pc-xxx:9093` on StreamNative cloud.
 - (optional) `token`: the token generated by the API key. It's allowed to be empty for quickly testing against a local Kafka cluster without any authentication.
 
-Run `./build/snctl-cpp -h` to see the help message.
-
 Options:
 - Add the `--config <config-file>` option to specify a different path of the INI config file.
 - Add a `--client-id` option to specify the client id of the underlying Kafka client. In Ursa, the client id carries the zone information, see [here](https://docs.streamnative.io/docs/config-kafka-client#eliminate-cross-az-networking-traffic).
 
 ### Create a topic
 
 ```bash
-$ ./build/snctl-cpp create tp0
+$ snctl-cpp create tp0
 Created topic "tp0" with 1 partition
-$ ./build/snctl-cpp create tp1 -p 5
+$ snctl-cpp create tp1 -p 5
 Created topic "tp1" with 5 partitions
 ```
 
 ### Delete a topic
 
 ```bash
-$ ./build/snctl-cpp delete tp
+$ snctl-cpp delete tp
 Failed to delete topic "tp": Broker: Unknown topic or partition
-$ ./build/snctl-cpp delete tp0
+$ snctl-cpp delete tp0
 Deleted topic "tp0"
 ```
 
@@ -51,7 +73,7 @@ Deleted topic "tp0"
 Query the owner brokers for all partitions:
 
 ```bash
-$ ./build/snctl-cpp describe <topic>
+$ snctl-cpp describe <topic>
 Partition[0] leader: {"id": 816909419, url: "pb0-<xxx>:9093"}"
 Partition[1] leader: {"id": 101337027, url: "pb4-<xxx>:9093"}"
 ...
@@ -61,7 +83,7 @@ Partition[15] leader: {"id": 644587507, url: "pb2-<xxx>:9093"}"
 Query the owner brokers for all partitions in a specific zone (`use1-az1` in this case):
 
 ```bash
-$ ./build/snctl-cpp --client-id zone_id=use1-az1 describe <topic>
+$ snctl-cpp --client-id zone_id=use1-az1 describe <topic>
 Partition[0] leader: {"id": 1868363245, url: "pb5-<xxx>:9093"}
 Partition[1] leader: {"id": 1868363245, url: "pb5-<xxx>:9093"}
 ...
@@ -75,7 +97,7 @@ As you can see, when a client specifies `use1-az1` as its zone, only brokers in
 List all topics and print the number of partitions for each topic:
 
 ```bash
-$ ./build/snctl-cpp list
+$ snctl-cpp list
 topic count: 2
 [0] "my-topic-2" with 1 partition
 [1] "my-topic-1" with 10 partitions