Skip to content

Commit 263a225

Browse files
cmdcolinclaude
andcommitted
README: clarify read convention, drop --save, link downstream packages
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent f195177 commit 263a225

1 file changed

Lines changed: 5 additions & 6 deletions

File tree

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,13 @@
44

55
Transparently read
66
[indexed block-gzipped (BGZF)](http://www.htslib.org/doc/bgzip.html) files, such
7-
as those created by bgzip, using coordinates from the uncompressed file. The
8-
module is used in @gmod/indexedfasta to read bgzip-indexed fasta files (with gzi
9-
index, fai index, and fa).
7+
as those created by bgzip, using coordinates from the uncompressed file.
108

11-
Uses WASM (libdeflate) for decompression.
9+
Uses WASM (libdeflate) for decompression. Used by [@gmod/indexedfasta](https://github.com/GMOD/indexedfasta) for bgzip-indexed FASTA files and [@gmod/bam](https://github.com/GMOD/bam-js) for BAM file decoding.
1210

1311
## Install
1412

15-
$ npm install --save @gmod/bgzf-filehandle
13+
$ npm install @gmod/bgzf-filehandle
1614

1715
## Usage
1816

@@ -30,7 +28,8 @@ const f = new BgzfFilehandle({
3028
gziFilehandle: new LocalFile('path/to/my_file.gz.gzi'),
3129
})
3230

33-
const data = await f.read(300, 0) // read(length, position) => Uint8Array
31+
// note: read(length, position) — matches generic-filehandle2 convention
32+
const data = await f.read(300, 0) // => Uint8Array
3433
```
3534

3635
### unzip

0 commit comments

Comments
 (0)