Update docs in prep for 1.2.2 release

codedread · Jan 26, 2024 · f738d73 · f738d73
1 parent e03fe7c
commit f738d73
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [1.2.2] - 2024-01-??
+## [1.2.2] - 2024-01-26
 
 ### Added
 

diff --git a/README.md b/README.md
@@ -48,8 +48,8 @@ const { getFullMIMEString } = await import('@codedread/bitjs');
 
 ### bitjs.archive
 
-This package includes objects for unarchiving binary data in popular archive formats (zip, rar, tar).
-Here is a simple example of unrar:
+This package includes objects for decompressing binary data in popular archive formats (zip, rar,
+tar). Here is a simple example of unrar:
 
 #### Decompressing
 

diff --git a/docs/bitjs.archive.md b/docs/bitjs.archive.md
@@ -4,8 +4,11 @@ This package includes objects for unarchiving binary data in popular archive for
 providing unzip, unrar and untar capabilities via JavaScript in the browser or various JavaScript
 runtimes (node, deno, bun).
 
-A prototype version of a compressor that creates Zip files is also present. The decompression /
-compression happens inside a Web Worker, if the runtime supports it (browsers, deno).
+A prototype version of a compressor that creates Zip files is also present.
+
+The decompression / compression happens inside a Web Worker, if the runtime supports it (browsers,
+deno). The library uses native decompression, if supported by the browser
+(via [DecompressionStream](https://developer.mozilla.org/en-US/docs/Web/API/DecompressionStream/DecompressionStream)), and falls back to JavaScript implementations otherwise.
 
 The API is event-based, you will want to subscribe to some of these events:
   * 'progress': Periodic updates on the progress (bytes processed).