Skip to content

Commit e46831b

Browse files
authored
Update readme (#46)
1 parent 2d3834d commit e46831b

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,19 @@
11
# async-tiff
22

3-
An async [TIFF](https://en.wikipedia.org/wiki/TIFF) reader.
3+
An async, low-level [TIFF](https://en.wikipedia.org/wiki/TIFF) reader.
44

5-
The existing [`tiff` crate](https://crates.io/crates/tiff) is great, but only supports synchronous reading of TIFF files. Furthermore, due to low maintenance bandwidth it is not designed for extensibility (see [#250](https://github.com/image-rs/image-tiff/issues/250)).
5+
## Features
6+
7+
- Support for tiled TIFF images.
8+
- Read directly from object storage providers, via the `object_store` crate.
9+
- Support for user-defined decompression algorithms.
10+
- Tile request merging and concurrency.
11+
12+
<!-- [Full documentation](https://docs.rs/async-tiff/). (version 0.1.0 will be published when object_store 0.12 is released.) -->
613

7-
This crate is designed to be a minimal, low-level interface to read tiled TIFF files in an async way.
14+
## Background
15+
16+
The existing [`tiff` crate](https://crates.io/crates/tiff) is great, but only supports synchronous reading of TIFF files. Furthermore, due to low maintenance bandwidth it is not designed for extensibility (see [#250](https://github.com/image-rs/image-tiff/issues/250)).
817

918
It additionally exposes geospatial-specific TIFF tag metadata.
1019

src/decoder.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ use crate::tiff::tags::{CompressionMethod, PhotometricInterpretation};
1212
use crate::tiff::{TiffError, TiffUnsupportedError};
1313

1414
/// A registry of decoders.
15+
///
16+
/// This allows end users to register their own decoders, for custom compression methods, or
17+
/// override the default decoder implementations.
1518
#[derive(Debug)]
1619
pub struct DecoderRegistry(HashMap<CompressionMethod, Box<dyn Decoder>>);
1720

0 commit comments

Comments
 (0)