docs

patrickkunka · Jun 9, 2020 · 99db25d · 99db25d
1 parent 80f207e
commit 99db25d
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+### 0.2.1
+- Fix node.js build
+- Build deno as ES2019 for compatibility
+
 ### 0.2.0
 
 - Bug fixes and accuracy/performance optimisations

diff --git a/README.md b/README.md
@@ -41,7 +41,13 @@ import {createBandwidthThrottleGroup} from 'bandwidth-throttle-stream';
 In Deno, all libraries are imported from URLs as ES modules. Versioned releases of `bandwidth-throttle-stream` are available from the [Pika](http://pika.dev) CDN:
 
 ```js
-import {createBandwidthThrottleGroup} from 'https://cdn.pika.dev/bandwidth-throttle-sream@^0.2.0/mod.ts';
+import {createBandwidthThrottleGroup} from 'https://cdn.pika.dev/bandwidth-throttle-sream/mod.ts';
+```
+
+The above URL will return the latest release, but it is strongly advised to lock your import to a specific version using the following syntax, where `.x.y.z` can be any published version of the library:
+
+```js
+import {createBandwidthThrottleGroup} from 'https://cdn.pika.dev/bandwidth-throttle-sream@x.y.z/mod.ts';
 ```
 
 ## Usage

diff --git a/config/typescript/tsconfig.build.deno.json b/config/typescript/tsconfig.build.deno.json
@@ -2,7 +2,7 @@
     "extends": "./tsconfig.base.json",
     "compilerOptions": {
         "outDir": "../../dist/deno",
-        "target": "ESNext",
+        "target": "ES2019",
         "module": "ESNext",
         "paths": {
             "@Platform": ["../../src/Platform/index.deno"]

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "bandwidth-throttle-stream",
-    "version": "0.2.0",
+    "version": "0.2.1",
     "description": "A Node.js and Deno transform stream for throttling bandwidth",
     "author": "KunkaLabs Limited",
     "private": false,
@@ -23,7 +23,7 @@
         "clean:dist": "rm -rf dist",
         "build:node": "ttsc -p ./config/typescript/tsconfig.build.node.json",
         "build:deno": "ttsc -p ./config/typescript/tsconfig.build.deno.json",
-        "build": "npm run clean:dist npm run build:node && npm run build:deno",
+        "build": "npm run clean:dist && npm run build:node && npm run build:deno",
         "lint": "tslint --project tsconfig.json -c ./config/tslint/tslint.json \"./src/**/*.ts\""
     },
     "husky": {