Skip to content

Add docs links to top-level README #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 18, 2025
+4 −3
Merged

Add docs links to top-level README #68

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# async-tiff

An async, low-level [TIFF](https://en.wikipedia.org/wiki/TIFF) reader.
An async, low-level [TIFF](https://en.wikipedia.org/wiki/TIFF) reader for Rust and Python.

[**Rust documentation**](https://docs.rs/async-tiff/) <br/>
[**Python documentation**](https://developmentseed.org/async-tiff/latest/)

## Features

Expand All @@ -9,8 +12,6 @@ An async, low-level [TIFF](https://en.wikipedia.org/wiki/TIFF) reader.
- Support for user-defined decompression algorithms.
- Tile request merging and concurrency.

[Full documentation](https://docs.rs/async-tiff/).

## 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)).
Expand Down