Skip to content

Commit

Permalink
leave some necessary docs in readme
Browse files Browse the repository at this point in the history
Signed-off-by: sh2 <[email protected]>
  • Loading branch information
shawnh2 committed Sep 11, 2023
1 parent 59f532d commit aedef74
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,25 @@
<img alt="screenshot" src="./docs/images/screenshot.png" width="800px">
</p>

## Quickstart

Install the `gtctl` binary using the following **one-line installatio**n command:

```console
curl -fsSL https://raw.githubusercontent.com/greptimeteam/gtctl/develop/hack/install.sh | sh
```

The **fastest** way to experience the GreptimeDB cluster is to use the playground:

```console
gtctl playground
```

The `playground` will deploy the minimal GreptimeDB cluster on your environment in bare-metal mode.

## Documentation

* [Quickstart](https://docs.greptime.com/user-guide/operations/gtctl) to install and use gtctl
* [More](https://docs.greptime.com/user-guide/operations/gtctl) features and usage about `gtctl`

## License

Expand Down

0 comments on commit aedef74

Please sign in to comment.