From eba3cd21cfce2fef57ac3c1937c96e4cb524fa59 Mon Sep 17 00:00:00 2001
From: James Telfer <792299+jamestelfer@users.noreply.github.com>
Date: Wed, 24 Jan 2024 14:27:13 +1100
Subject: [PATCH] docs: update for vs

---
 README.md | 15 +++++++++++++--
 1 file changed, 13 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 56e1a7a..f1bc949 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@ CDK constructs for the [DataDog CFN resources](https://github.com/DataDog/datado
 > In order to use these resources, you need to ensure that they are configured
 > in your environment. See instructions in the above repo.
 
-Currently support AWS CDK v1 (v2 coming) on the following resource types:
+Currently supports AWS CDK v2 [^1] on the following resource types:
 
 - `Datadog::Dashboards::Dashboard`
 - `Datadog::Monitors::Monitor`
@@ -14,11 +14,13 @@ Currently support AWS CDK v1 (v2 coming) on the following resource types:
 - `Datadog::SLOs::SLO`
   - `Creator` attribute not directly supported (use an escape hatch)
 
+[^1]: v1 support is present via the v1.0.0 release of the package
+
 ## Status
 
 This package is currently released as a public package on the Github NPM repository.
 
-Still to be considered v1:
+Contributions welcome for:
 
 - [ ] unit tests for all L1 constructs
 - [ ] integration tests for all L1 constructs
@@ -27,3 +29,12 @@ Still to be considered v1:
 
 Contributions are welcome: be sure to open an issue though before embarking on
 any large-scale endeavours!
+
+## Publishing
+
+Publishing requires a GH token in the environment named `GITHUB_REGISTRY_PUBLISH_TOKEN`. It requires `repo` and `write:packages` permissions.
+
+```shell
+pnpm run prebuildpackage
+npm publish
+```