staticmaps

# Changelog

Notable changes to StaticMaps, newest first. Versions follow
[Semantic Versioning](https://semver.org); before 1.0, a minor version may change the API.

## 0.1.1 — 2026-10-26

Documentation only. The one visible effect is that `StaticMaps.Plug`'s ETags include the
library version, so a browser revalidating a map after the upgrade gets it re-rendered once
rather than a `304`.

- The README is now a short introduction, with guides for rendering maps, tile sources
  and caching, and serving over HTTP.
- The diagrams are SVG images that follow a light or dark theme.
- Corrected API docs:
  - `render/1` documents `:bounds`, `:markers`, `:padding` and `:attribution`, and that
    `:center` and `:zoom` are optional when the view can be fitted.
  - `StaticMaps.Plug.path/3` lists the options a URL can carry.
  - The Plug's responses table includes `500`.

## 0.1.0 — 2026-10-23

The first release.

- `StaticMaps.render/1`: a map image from a centre and zoom, or fitted to bounds and
  markers, as PNG or JPEG, at scale 1 or 2.
- Tile sources: `Source.OSM`, `Source.Template` for any URL template, mirrors, fallback
  sources, and a circuit breaker for sources that keep failing.
- A tile cache that honours the server's freshness headers, revalidates expired tiles,
  and can be turned off per source with `cache: false`.
- Markers: the default pin in any colour, with an optional label, or custom SVG and image
  icons.
- An attribution strip on every image, crediting the source the image came from.
- `StaticMaps.Plug`, optional: maps served from signed URLs, with HTTP caching headers
  for browsers and CDNs.