Skip to content

Commit 1cd392e

Browse files
committed
Tweak README
1 parent d2f3516 commit 1cd392e

File tree

1 file changed

+9
-12
lines changed

1 file changed

+9
-12
lines changed

README.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Includes:
1414
* bitjs/codecs: Get the codec info of media containers in a ISO RFC6381
1515
MIME type string
1616
* bitjs/file: Detect the type of file from its binary signature.
17-
* bitjs/image: Parsing GIF, JPEG. Conversion of WebP to PNG or JPEG.
17+
* bitjs/image: Parsing GIF, JPEG, PNG. Conversion of WebP to PNG or JPEG.
1818
* bitjs/io: Low-level classes for interpreting binary data (BitStream
1919
ByteStream). For example, reading or peeking at N bits at a time.
2020

@@ -107,10 +107,10 @@ const mimeType = findMimeType(someArrayBuffer);
107107

108108
### bitjs.image
109109

110-
This package includes code for dealing with binary images. It includes general event-based parsers
111-
for images (GIF, JPEG, PNG). It also includes a module for converting WebP images
112-
into alternative raster graphics formats (PNG/JPG). This latter module is deprecated, now that WebP
113-
images are well-supported in all browsers.
110+
This package includes code for dealing with binary images. It includes low-level, event-based
111+
parsers for GIF, JPEG, and PNG images. It also includes a module for converting WebP images into
112+
alternative raster graphics formats (PNG/JPG), though this latter module is deprecated, now that
113+
WebP images are well-supported in all browsers.
114114

115115
#### GIF Parser
116116
```javascript
@@ -134,10 +134,8 @@ parser.start();
134134
import { JpegParser } from './bitjs/image/parsers/jpeg.js'
135135
import { ExifTagNumber } from './bitjs/image/parsers/exif.js';
136136

137-
const parser = new JpegParser(someArrayBuffer);
138-
parser.onApp1Exif(evt => {
139-
console.log(evt.detail.get(ExifTagNumber.IMAGE_DESCRIPTION).stringValue);
140-
});
137+
const parser = new JpegParser(someArrayBuffer)
138+
.onApp1Exif(evt => console.log(evt.detail.get(ExifTagNumber.IMAGE_DESCRIPTION).stringValue));
141139
await parser.start();
142140
```
143141

@@ -147,9 +145,8 @@ import { PngParser } from './bitjs/image/parsers/png.js'
147145
import { ExifTagNumber } from './bitjs/image/parsers/exif.js';
148146

149147
const parser = new PngParser(someArrayBuffer);
150-
parser.onExifProfile(evt => {
151-
console.log(evt.detail.get(ExifTagNumber.IMAGE_DESCRIPTION).stringValue);
152-
});
148+
.onExifProfile(evt => console.log(evt.detail.get(ExifTagNumber.IMAGE_DESCRIPTION).stringValue))
149+
.onTextualData(evt => console.dir(evt.detail));
153150
await parser.start();
154151
```
155152

0 commit comments

Comments
 (0)