From 0f011d5b921a7baa77ed6b7a61fff50bffaebc82 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Felix=20Geisend=C3=B6rfer?= Date: Fri, 22 Mar 2024 13:14:08 +0100 Subject: [PATCH] README --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 10b023a..74349f3 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,12 @@ datadog-pgo is a tool for integrating continuous [profile-guided optimization](https://go.dev/doc/pgo) (PGO) into your Go build process. It fetches representative CPU profiles from Datadog and merges them into a `default.pgo` file that is used by the Go toolchain to optimize your application. +## ⚠️ Public Beta + +* This tool is currently in limited public beta. Please open a GitHub issue if you have any feedback or questions. +* Always use the latest version of datadog-pgo in CI as shown below. Old versions may become deprecated and stop working on short notice. +* We're considering to integrate this tool into [datadog-ci](https://github.com/DataDog/datadog-ci). Please let us know if you're interested in this. + ## Getting Started 1. Create a dedicated API key and unscoped Application key for PGO as described in the [documentation](https://docs.datadoghq.com/account_management/api-app-keys/). @@ -12,10 +18,6 @@ datadog-pgo is a tool for integrating continuous [profile-guided optimization](h go run github.com/DataDog/datadog-pgo@latest 'service:foo env:prod' ./cmd/foo/default.pgo ``` -### ⚠️ Public Beta Notes -* Always use the latest version of datadog-pgo in CI as shown above. Old versions may become deprecated and stop working on short notice. -* We're considering to integrate this tool into [datadog-ci](https://github.com/DataDog/datadog-ci). Please let us know if you're interested in this. - ## CLI