From 0334453b11a183bcc27798c67509d7b9bbbf347f Mon Sep 17 00:00:00 2001
From: Kyle Barron <kyle@developmentseed.org>
Date: Wed, 22 Nov 2023 17:20:50 -0500
Subject: [PATCH] Update README (#12)

* Update README

* update version
---
 CHANGELOG.md | 11 +++++++++++
 README.md    | 22 ++++++++++++++++++++--
 package.json |  2 +-
 3 files changed, 32 insertions(+), 3 deletions(-)
 create mode 100644 CHANGELOG.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..3af9690
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,11 @@
+# Changelog
+
+## [0.1.0] - 2023-11-22
+
+- Initial release.
+- Support for:
+  - Polygon area and signed area
+  - Polygon winding order
+  - Polygon triangulation
+  - Coordinate reprojection
+  - Total bounds
diff --git a/README.md b/README.md
index 5a3d704..4164c90 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,21 @@
-# `@geoarrow/geoarrow-js`
+# `geoarrow-js`
 
-TypeScript implementation of GeoArrow.
+A minimal TypeScript implementation of [GeoArrow](https://geoarrow.org/).
+
+This builds on top of [Arrow JS](https://arrow.apache.org/docs/js/index.html) to provide type definitions for geoarrow `Data` and `Vector` objects, as well as selected geometry operations.
+
+It also complements the work-in-progress `geoarrow-wasm`, which will provide Rust-based operations on GeoArrow memory.
+
+## Spatial operations
+
+Only spatial operations that are implemented on binary representations of geometry will be added to this repo.
+
+This means that `geoarrow-js` will not, say, use algorithms from [Turf](https://turfjs.org/), because that would require conversions to and from GeoJSON for the operation.
+
+### Implemented algorithms:
+
+- Polygon area and signed area (via [`@math.gl/polygon`](https://github.com/visgl/math.gl))
+- Polygon winding order (via [`@math.gl/polygon`](https://github.com/visgl/math.gl))
+- Polygon triangulation (via [`@math.gl/polygon`](https://github.com/visgl/math.gl), a fork of [`earcut`](https://github.com/mapbox/earcut).)
+- Coordinate reprojection (via [`proj4`](https://github.com/proj4js/proj4js))
+- Total bounds (the bounding box of an array of geometries).
diff --git a/package.json b/package.json
index 165aba9..e84ee4a 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@geoarrow/geoarrow-js",
-  "version": "0.1.0-beta.1",
+  "version": "0.1.0",
   "description": "TypeScript implementation of GeoArrow",
   "source": "src/index.ts",
   "umd:main": "dist/geoarrow.umd.js",