From dd95e6b4a35a63e3180990a47ed33e6c1d2e17b7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcus=20P=C3=B6hls?= Date: Mon, 6 Nov 2023 05:17:09 +0100 Subject: [PATCH] update readme --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 36c8207..8a88eb2 100644 --- a/README.md +++ b/README.md @@ -36,11 +36,15 @@ npm i @supercharge/queue-datastructure ``` +## Notice +This package is ESM-only. + + ## Usage Using the queue data structure is pretty straightforward. The library exposes a `Queue` class that you can use to create a queue instance. You can create a queue from existing data or an empty one: ```js -const Queue = require('@supercharge/queue-datastructure') +import { Queue } from '@supercharge/queue-datastructure' // create a queue from an existing array const queue = new Queue([ 1, 2, 3 ])