Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nicecui committed Jul 25, 2023
1 parent 8756802 commit 9bbdf5c
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,30 @@

This is a quick start demo for [GreptimeCloud](https://greptime.cloud/). It collects the system metric data such as CPU and memory usage through Opentelemetry and sends the metrics to GreptimeCloud. You can view the metrics on the GreptimeCloud dashboard.

Use the following command line to start it:
## Quick Start

Use the following command line to start sending metrics without cloning the project:

```shell
go run github.com/GreptimeCloudStarters/quick-start-go@latest -host=<host> -db=<dbname> -username=<username> -password=<password>
```

Or clone the project and run the following command line:

```shell
go run . -host=<host> -db=<dbname> -username=<username> -password=<password>
```

## Release

1. Update the version in `app.go`.
2. Commit and push code.
3. Create a tag with the version and push it to the remote repository.

```shell
git tag v<major>.<minor>.<patch>
git push origin v<major>.<minor>.<patch>
```

4. Update pkg.go.dev via `GOPROXY=proxy.golang.org go list -m github.com/GreptimeCloudStarters/quick-start-go@v<major>.<minor>.<patch>`
5. Write change log in [Github Release](https://github.com/GreptimeCloudStarters/quick-start-go/tags).
2 changes: 1 addition & 1 deletion app.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import (
semconv "go.opentelemetry.io/otel/semconv/v1.17.0"
)

const Version = "0.1.2"
const Version = "1.0.0"

var dbHost = flag.String("host", "localhost", "The host address of the GreptimeCloud service")
var db = flag.String("db", "public", "The name of the database of the GreptimeCloud service")
Expand Down

0 comments on commit 9bbdf5c

Please sign in to comment.