Skip to content

Commit 51c209f

Browse files
authored
docs: Write project goals into readme (#4)
1 parent d901703 commit 51c209f

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,20 @@
11
# async-geotiff
2-
Async GeoTIFF reader for Python
2+
3+
Async GeoTIFF and [Cloud-Optimized GeoTIFF][cogeo] (COG) reader for Python, wrapping [`async-tiff`].
4+
5+
[`async-tiff`]: https://github.com/developmentseed/async-tiff
6+
[cogeo]: https://cogeo.org/
7+
8+
## Project Goals:
9+
10+
- Support only for GeoTIFF and Cloud-Optimized GeoTIFF (COG) formats
11+
- Support for reading only, no writing support
12+
- Full type hinting.
13+
- API similar to rasterio where possible.
14+
- We won't support the full rasterio API, but we'll try to when it's possible to implement rasterio APIs with straightforward maintenance requirements.
15+
- For methods where we do intentionally try to match with rasterio, the tests should match against rasterio.
16+
- Initially, we'll try to support a core set of GeoTIFF formats. Obscure GeoTIFF files may not be supported.
17+
18+
## References
19+
20+
- aiocogeo: https://github.com/geospatial-jeff/aiocogeo

0 commit comments

Comments
 (0)