Skip to content

Commit f738d73

Browse files
committed
Update docs in prep for 1.2.2 release
1 parent e03fe7c commit f738d73

File tree

3 files changed

+8
-5
lines changed

3 files changed

+8
-5
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
All notable changes to this project will be documented in this file.
44

5-
## [1.2.2] - 2024-01-??
5+
## [1.2.2] - 2024-01-26
66

77
### Added
88

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ const { getFullMIMEString } = await import('@codedread/bitjs');
4848

4949
### bitjs.archive
5050

51-
This package includes objects for unarchiving binary data in popular archive formats (zip, rar, tar).
52-
Here is a simple example of unrar:
51+
This package includes objects for decompressing binary data in popular archive formats (zip, rar,
52+
tar). Here is a simple example of unrar:
5353

5454
#### Decompressing
5555

docs/bitjs.archive.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,11 @@ This package includes objects for unarchiving binary data in popular archive for
44
providing unzip, unrar and untar capabilities via JavaScript in the browser or various JavaScript
55
runtimes (node, deno, bun).
66

7-
A prototype version of a compressor that creates Zip files is also present. The decompression /
8-
compression happens inside a Web Worker, if the runtime supports it (browsers, deno).
7+
A prototype version of a compressor that creates Zip files is also present.
8+
9+
The decompression / compression happens inside a Web Worker, if the runtime supports it (browsers,
10+
deno). The library uses native decompression, if supported by the browser
11+
(via [DecompressionStream](https://developer.mozilla.org/en-US/docs/Web/API/DecompressionStream/DecompressionStream)), and falls back to JavaScript implementations otherwise.
912

1013
The API is event-based, you will want to subscribe to some of these events:
1114
* 'progress': Periodic updates on the progress (bytes processed).

0 commit comments

Comments
 (0)