diff --git a/README.md b/README.md index c1180469..08abfefa 100644 --- a/README.md +++ b/README.md @@ -12,17 +12,25 @@ screenshot

-## Quickstart +## Installation -Install the `gtctl` binary using the following **one-line installatio**n command: +Install `gtctl` using the following **oneliner installation** command: -```console +```shell curl -fsSL https://raw.githubusercontent.com/greptimeteam/gtctl/develop/hack/install.sh | sh ``` +In case of `go` is available, you can alternatively install `gtctl` with: + +```shell +go install github.com/GreptimeTeam/gtctl/cmd/gtctl@develop +``` + +## Quickstart + The **fastest** way to experience the GreptimeDB cluster is to use the playground: -```console +```shell gtctl playground ``` @@ -34,4 +42,4 @@ The `playground` will deploy the minimal GreptimeDB cluster on your environment ## License -`gtctl` uses the [Apache 2.0 license](./LICENSE) to strike a balance between open contributions and allowing you to use the software however you want. +`gtctl` uses the [Apache 2.0 license](LICENSE) to strike a balance between open contributions and allowing you to use the software however you want.