Skip to content

Commit 5df3dc1

Browse files
authored
docs: improve README (#63)
1 parent e776cb5 commit 5df3dc1

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed

README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,20 @@
1-
# tiff
2-
3-
TIFF image decoder written entirely in JavaScript.
4-
51
<h3 align="center">
6-
72
<a href="https://www.zakodium.com">
83
<img src="https://www.zakodium.com/brand/zakodium-logo-white.svg" width="50" alt="Zakodium logo" />
94
</a>
10-
115
<p>
126
Maintained by <a href="https://www.zakodium.com">Zakodium</a>
137
</p>
8+
</h3>
9+
10+
# tiff
1411

1512
[![NPM version][npm-image]][npm-url]
16-
[![build status][ci-image]][ci-url]
1713
[![npm download][download-image]][download-url]
14+
[![test coverage][codecov-image]][codecov-url]
15+
[![license][license-image]][license-url]
1816

19-
</h3>
17+
TIFF image decoder written entirely in TypeScript.
2018

2119
## Installation
2220

@@ -37,7 +35,7 @@ Images compressed with Zlib/deflate algorithm are also supported.
3735

3836
## API
3937

40-
### tiff.decode(data[, options])
38+
### `tiff.decode(data[, options])`
4139

4240
Decodes the file and returns TIFF IFDs.
4341

@@ -62,11 +60,11 @@ The `data` property is a Typed Array containing the pixel data. It is a
6260
- `yResolution`
6361
- `resolutionUnit`
6462

65-
### tiff.pageCount(data)
63+
### `tiff.pageCount(data)`
6664

6765
Returns the number of IFDs (pages) in the file.
6866

69-
### tiff.isMultiPage(data)
67+
### `tiff.isMultiPage(data)`
7068

7169
Returns true if the file has 2 or more IFDs (pages) and false if it has 1.
7270
This is slightly more efficient than calling `pageCount()` if all you need to
@@ -78,9 +76,9 @@ know is whether the file has multiple pages or not.
7876

7977
[npm-image]: https://img.shields.io/npm/v/tiff.svg
8078
[npm-url]: https://www.npmjs.com/package/tiff
81-
[ci-image]: https://github.com/image-js/tiff/workflows/Node.js%20CI/badge.svg?branch=main
82-
[ci-url]: https://github.com/image-js/tiff/actions?query=workflow%3A%22Node.js+CI%22
83-
[codecov-image]: https://img.shields.io/codecov/c/github/image-js/tiff.svg
84-
[codecov-url]: https://codecov.io/gh/image-js/tiff
8579
[download-image]: https://img.shields.io/npm/dm/tiff.svg
8680
[download-url]: https://www.npmjs.com/package/tiff
81+
[codecov-image]: https://img.shields.io/codecov/c/github/image-js/tiff.svg
82+
[codecov-url]: https://app.codecov.io/gh/image-js/tiff
83+
[license-image]: https://img.shields.io/npm/l/tiff.svg
84+
[license-url]: https://github.com/image-js/tiff/blob/main/LICENSE

0 commit comments

Comments
 (0)