Skip to content

Commit 4af223a

Browse files
committed
Note Deno support in README
1 parent c40a505 commit 4af223a

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@
44
[![NPM Version][npm-image]][npm-url]
55
[![Build Status][ci-status-image]][ci-status-url]
66
[![Downloads Stats][npm-downloads]][npm-url]
7+
![deno compatibility][deno-image]
78

89
Datadog-metrics lets you collect application metrics through Datadog's HTTP API. Using the HTTP API has the benefit that you **don't need to install the Datadog Agent (StatsD)**. Just get an API key, install the module and you're ready to go.
910

1011
The downside of using the HTTP API is that it can negatively affect your app's performance. Datadog-metrics **solves this issue by buffering metrics locally and periodically flushing them** to Datadog.
1112

1213
## Installation
1314

14-
Datadog-metrics is compatible with Node.js v14 and later. You can install it with NPM:
15+
Datadog-metrics is compatible with Node.js v14 and later and Deno 2.0 and later. You can install it with NPM:
1516

1617
```sh
1718
npm install datadog-metrics --save
@@ -371,13 +372,13 @@ Contributions are always welcome! For more info on how to contribute or develop
371372

372373
**Breaking Changes:**
373374

374-
* The minimum required Node.js version is now v14.0.0.
375+
* The minimum required Node.js version is now v14.0.0 and Deno version is 2.0.0.
375376

376377
* The `code` property on `AuthorizationError` instances has been changed to `DATADOG_METRICS_AUTHORIZATION_ERROR` for clarity and consistency (it was previously `DATADOG_AUTHORIZATION_ERROR`). If you are using `errorInstance.code` to check types, make sure to update the string you were looking for.
377378

378379
**New Features:**
379380

380-
TBD
381+
* Clarify this package is compatible with Deno (>= v2.0). We’ve silently worked on Deno for a long time, but never formally supported it before this release.
381382

382383
**Deprecations:**
383384

@@ -799,3 +800,4 @@ Your contributions are always welcome! See [`CONTRIBUTING.md`](./CONTRIBUTING.md
799800
[npm-downloads]: https://img.shields.io/npm/dm/datadog-metrics.svg?style=flat-square
800801
[ci-status-image]: https://github.com/dbader/node-datadog-metrics/actions/workflows/ci.yml/badge.svg?branch=main
801802
[ci-status-url]: https://github.com/dbader/node-datadog-metrics/actions/workflows/ci.yml?query=branch%3Amain
803+
[deno-image]: https://shield.deno.dev/deno/2.0

0 commit comments

Comments
 (0)