Skip to content

Commit 0334453

Browse files
authored
Update README (#12)
* Update README * update version
1 parent ec8d0dc commit 0334453

File tree

3 files changed

+32
-3
lines changed

3 files changed

+32
-3
lines changed

CHANGELOG.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Changelog
2+
3+
## [0.1.0] - 2023-11-22
4+
5+
- Initial release.
6+
- Support for:
7+
- Polygon area and signed area
8+
- Polygon winding order
9+
- Polygon triangulation
10+
- Coordinate reprojection
11+
- Total bounds

README.md

+20-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1-
# `@geoarrow/geoarrow-js`
1+
# `geoarrow-js`
22

3-
TypeScript implementation of GeoArrow.
3+
A minimal TypeScript implementation of [GeoArrow](https://geoarrow.org/).
4+
5+
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.
6+
7+
It also complements the work-in-progress `geoarrow-wasm`, which will provide Rust-based operations on GeoArrow memory.
8+
9+
## Spatial operations
10+
11+
Only spatial operations that are implemented on binary representations of geometry will be added to this repo.
12+
13+
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.
14+
15+
### Implemented algorithms:
16+
17+
- Polygon area and signed area (via [`@math.gl/polygon`](https://github.com/visgl/math.gl))
18+
- Polygon winding order (via [`@math.gl/polygon`](https://github.com/visgl/math.gl))
19+
- Polygon triangulation (via [`@math.gl/polygon`](https://github.com/visgl/math.gl), a fork of [`earcut`](https://github.com/mapbox/earcut).)
20+
- Coordinate reprojection (via [`proj4`](https://github.com/proj4js/proj4js))
21+
- Total bounds (the bounding box of an array of geometries).

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@geoarrow/geoarrow-js",
3-
"version": "0.1.0-beta.1",
3+
"version": "0.1.0",
44
"description": "TypeScript implementation of GeoArrow",
55
"source": "src/index.ts",
66
"umd:main": "dist/geoarrow.umd.js",

0 commit comments

Comments
 (0)