Skip to content

Commit

Permalink
Update README (#12)
Browse files Browse the repository at this point in the history
* Update README

* update version
  • Loading branch information
kylebarron authored Nov 22, 2023
1 parent ec8d0dc commit 0334453
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 3 deletions.
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down

0 comments on commit 0334453

Please sign in to comment.