Skip to content

Commit

Permalink
docs: update for vs
Browse files Browse the repository at this point in the history
  • Loading branch information
jamestelfer committed Jan 24, 2024
1 parent db84edf commit eba3cd2
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand All @@ -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
Expand All @@ -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
```

0 comments on commit eba3cd2

Please sign in to comment.