Skip to content

Commit 9b1dfe8

Browse files
committed
Tweak headings in README
1 parent 623e99c commit 9b1dfe8

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,7 @@ or
2222
$ yarn add @codedread/bitjs
2323
```
2424

25-
## Example Usage
26-
27-
### bitjs.archive
25+
## bitjs.archive
2826

2927
This package includes objects for unarchiving binary data in popular archive formats (zip, rar, tar) providing unzip, unrar and untar capabilities via JavaScript in the browser. A prototype version of a compressor that creates Zip files is also present. The decompression/compression actually happens inside a Web Worker.
3028

@@ -96,7 +94,7 @@ const zippedArrayBuffer = await zipper.start(
9694
true /* isLastFile */);
9795
```
9896

99-
### bitjs.codecs
97+
## bitjs.codecs
10098

10199
This package includes code for dealing with media files (audio/video). It is useful for deriving
102100
ISO RFC6381 MIME type strings, including the codec information. Currently supports a limited subset
@@ -119,7 +117,7 @@ exec(cmd, (error, stdout) => {
119117
const contentType = getFullMIMEString(info);
120118
```
121119
122-
### bitjs.file
120+
## bitjs.file
123121
124122
This package includes code for dealing with files. It includes a sniffer which detects the type of file, given an ArrayBuffer.
125123
@@ -128,7 +126,7 @@ import { findMimeType } from './bitjs/file/sniffer.js';
128126
const mimeType = findMimeType(someArrayBuffer);
129127
```
130128
131-
### bitjs.image
129+
## bitjs.image
132130
133131
This package includes code for dealing with binary images. It includes a module for converting WebP images into alternative raster graphics formats (PNG/JPG).
134132
@@ -143,7 +141,7 @@ convertWebPtoPNG(webpBuffer).then(pngBuf => {
143141
});
144142
```
145143
146-
### bitjs.io
144+
## bitjs.io
147145
148146
This package includes stream objects for reading and writing binary data at the bit and byte level: BitStream, ByteStream.
149147
@@ -154,7 +152,7 @@ const crc = bstream.readBits(12); // read in 12 bits as CRC, advancing the point
154152
const flagbits = bstream.peekBits(6); // look ahead at next 6 bits, but do not advance the pointer
155153
```
156154
157-
## Other Tests
155+
# Other Tests
158156
159157
Those that haven't been ported to mocha/chai/nodejs.
160158

0 commit comments

Comments
 (0)