Skip to content

docs: Add examples to readme #188

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
kylebarron merged 1 commit into from
Jan 15, 2026
Merged

docs: Add examples to readme #188

Show file tree
Hide file tree
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
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@ Fully client-side with direct image loading, no server required.

[^1]: The raster reprojection has not been tested on polar projections or when spanning the antimeridian.

## Examples

- **[Land Cover](https://developmentseed.org/deck.gl-raster/examples/land-cover/)**: 1.3GB NLCD land cover COG with custom colormap
- **[NAIP Client-side Mosaic](https://developmentseed.org/deck.gl-raster/examples/naip-mosaic/)**: Client-side mosaic of [NAIP](https://www.usgs.gov/centers/eros/science/usgs-eros-archive-aerial-photography-national-agriculture-imagery-program-naip) COGs, loaded directly from [Microsoft Planetary Computer](https://planetarycomputer.microsoft.com/dataset/naip). No server involved. Switch between true color, false color infrared, and NDVI renderings
- **[COG Basic](https://developmentseed.org/deck.gl-raster/examples/cog-basic/)**: RGB aerial imagery with automatic reprojection

## Quick Start

```typescript
Expand Down
2 changes: 2 additions & 0 deletions examples/cog-basic/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This example demonstrates how to use the `COGLayer` to visualize a Cloud-Optimized GeoTIFF (COG) in deck.gl.

Deployed to <https://developmentseed.org/deck.gl-raster/examples/cog-basic/>.

## Features

- Loads and displays RGB imagery from a GeoTIFF file
Expand Down
2 changes: 2 additions & 0 deletions examples/land-cover/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This example visualizes a 1.3GB land cover dataset using deck.gl and the `COGLayer`.

Deployed to <https://developmentseed.org/deck.gl-raster/examples/land-cover/>.

## Setup

1. Install dependencies from the repository root:
Expand Down
2 changes: 2 additions & 0 deletions examples/naip-mosaic/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This example demonstrates how to use the `MosaicLayer` to visualize a client-side mosaic of Cloud-Optimized GeoTIFFs (COGs) in deck.gl.

Deployed to <https://developmentseed.org/deck.gl-raster/examples/naip-mosaic/>.

## Setup

1. Install dependencies from the repository root:
Expand Down