From 8fc5118bef50a57eaa70163400c775048cdb5038 Mon Sep 17 00:00:00 2001 From: Kyle Barron Date: Wed, 5 Mar 2025 13:57:52 -0500 Subject: [PATCH] Update readme --- README.md | 15 ++++++++++++--- src/decoder.rs | 3 +++ 2 files changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2ca5eca..fd80ce0 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,19 @@ # async-tiff -An async [TIFF](https://en.wikipedia.org/wiki/TIFF) reader. +An async, low-level [TIFF](https://en.wikipedia.org/wiki/TIFF) reader. -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)). +## Features + +- Support for tiled TIFF images. +- Read directly from object storage providers, via the `object_store` crate. +- Support for user-defined decompression algorithms. +- Tile request merging and concurrency. + + -This crate is designed to be a minimal, low-level interface to read tiled TIFF files in an async way. +## Background + +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)). It additionally exposes geospatial-specific TIFF tag metadata. diff --git a/src/decoder.rs b/src/decoder.rs index d4298fc..faf5a17 100644 --- a/src/decoder.rs +++ b/src/decoder.rs @@ -12,6 +12,9 @@ use crate::tiff::tags::{CompressionMethod, PhotometricInterpretation}; use crate::tiff::{TiffError, TiffUnsupportedError}; /// A registry of decoders. +/// +/// This allows end users to register their own decoders, for custom compression methods, or +/// override the default decoder implementations. #[derive(Debug)] pub struct DecoderRegistry(HashMap>);