From 41203be8b70a67e3406629a4d23ee03931283076 Mon Sep 17 00:00:00 2001 From: dennis zhuang Date: Wed, 5 Aug 2026 10:06:03 +0800 Subject: [PATCH] docs: rework README release badges, drop star history, fix grpc flag (#8743) * docs: show stable, latest and nightly version badges in README The single release badge rendered whatever GitHub considered newest, so a pre-release such as v1.2.0-beta.1 looked like the recommended version. Split it into three self-updating badges using the shields.io `filter` parameter, keyed off the existing tag naming: - stable: `!*-*` matches tags without a hyphen (v1.1.4) - latest: `!*-*-*` excludes nightly and dev builds (v1.2.0-beta.1) - nightly: `*-nightly-*` matches the weekly build (v1.2.0-nightly-20260706) No workflow changes are needed; the badges track new releases on their own. A one-line caption below them says which channel to pick. The release-date badge is dropped as the three version badges already carry that signal. Signed-off-by: Dennis Zhuang * docs: remove star history chart from README The chart carried a sealed_token in three URLs and added a large third-party image to the Project Status section without saying anything the badges and case studies do not already cover. Signed-off-by: Dennis Zhuang * docs: use --grpc-bind-addr in README quickstart --rpc-bind-addr is now only a hidden alias of --grpc-bind-addr and no longer shows up in --help. Signed-off-by: Dennis Zhuang * Update README.md Co-authored-by: Ning Sun --------- Signed-off-by: Dennis Zhuang Co-authored-by: Ning Sun --- README.md | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 66b6be8fdb..019a7c848b 100644 --- a/README.md +++ b/README.md @@ -19,11 +19,17 @@ replacing Prometheus, Loki, and Elasticsearch -Version +Stable - -Releases + +Canary + +Nightly + + +stable for production  ·  latest includes pre-releases  ·  nightly is a weekly snapshot of main + Docker Pulls @@ -149,7 +155,7 @@ docker run -p 127.0.0.1:4000-4003:4000-4003 \ --name greptime --rm \ greptime/greptimedb:latest standalone start \ --http-addr 0.0.0.0:4000 \ - --rpc-bind-addr 0.0.0.0:4001 \ + --grpc-bind-addr 0.0.0.0:4001 \ --mysql-addr 0.0.0.0:4002 \ --postgres-addr 0.0.0.0:4003 ``` @@ -209,14 +215,6 @@ Read the [v1.0 highlights](https://greptime.com/blogs/2025-11-05-greptimedb-v1-h If GreptimeDB is useful to you, please star the repo. - - - - - Star History Chart - - - Known Users ## Community