Skip to content

Commit 8314144

Browse files
cmdcolinclaude
andcommitted
Clean up README: remove stale version note, add pnpm install, link example dir
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 88ea34c commit 8314144

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
Read CRAM files (indexed or unindexed) with pure JS, works in node or in the
77
browser.
88

9-
- Reads CRAM 3.x and 2.x (3.1 added in v1.6.0)
9+
- Reads CRAM 3.x and 2.x
1010
- Does not read CRAM 1.x
1111
- Can use .crai indexes out of the box, for efficient sequence fetching, but
1212
also has an [index API](#craiindex) that would allow use with other index
@@ -18,9 +18,11 @@ browser.
1818
## Install
1919

2020
```bash
21-
$ npm install --save @gmod/cram
21+
$ npm install @gmod/cram
2222
# or
2323
$ yarn add @gmod/cram
24+
# or
25+
$ pnpm add @gmod/cram
2426
```
2527

2628
## Usage
@@ -114,8 +116,8 @@ records.forEach(record => {
114116
})
115117
```
116118

117-
You can use cram-js without NPM also with the cram-bundle.js. See the example
118-
directory for usage with script tag
119+
You can use cram-js without NPM also with the cram-bundle.js. See the
120+
[example directory](./example) for usage with script tag.
119121

120122
## API (auto-generated)
121123

0 commit comments

Comments
 (0)