Skip to content

Commit 6a9d121

Browse files
committed
Mark geoparquet package as deprecated
1 parent 3ff835b commit 6a9d121

File tree

2 files changed

+24
-14
lines changed

2 files changed

+24
-14
lines changed

README.md

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# GeoParquet
2-
31
![GeoParquet parakeets gathered around a map](geoparquet.jpg)
42

53
[![npm](https://img.shields.io/npm/v/geoparquet)](https://www.npmjs.com/package/geoparquet)
@@ -9,6 +7,29 @@
97
![coverage](https://img.shields.io/badge/Coverage-95-darkred)
108
[![dependencies](https://img.shields.io/badge/Dependencies-1-blueviolet)](https://www.npmjs.com/package/geoparquet?activeTab=dependencies)
119

10+
# GeoParquet is DEPRECATED
11+
12+
This GeoParquet JS library has been deprecated in favor of native support for GeoParquet in [hyparquet](https://github.com/hyparam/hyparquet).
13+
14+
We recommend using hyparquet directly for reading GeoParquet files:
15+
16+
```javascript
17+
const { asyncBufferFromUrl, parquetReadObjects } = await import('hyparquet')
18+
19+
const file = await asyncBufferFromUrl({ url: 'example.parquet' })
20+
const data = await parquetReadObjects({ file })
21+
const geojson = {
22+
type: 'FeatureCollection',
23+
features: data.map(({ geometry, ...properties }) => ({
24+
type: 'Feature',
25+
geometry,
26+
properties,
27+
}))
28+
}
29+
```
30+
31+
# GeoParquet
32+
1233
**GeoParquet** provides a pure JavaScript workflow to read and convert [GeoParquet](https://github.com/opengeospatial/geoparquet) files into [GeoJSON](https://datatracker.ietf.org/doc/html/rfc7946). Under the hood, it uses the [hyparquet](https://github.com/hyparam/hyparquet) library for efficient in-browser parquet parsing, enabling minimal overhead and fast loading.
1334

1435
## Why GeoParquet?
@@ -19,17 +40,6 @@
1940
- **Faster loading:** Pure JavaScript parsing of Parquet files in the browser, with tiny package size means fast page load times.
2041
- **Seamless integration:** GeoParquet is based on well-established standards (GeoJSON, Parquet), ensuring broad compatibility and extensibility.
2142

22-
## Usage
23-
24-
Convert a GeoParquet file to GeoJSON:
25-
26-
```javascript
27-
const { asyncBufferFromUrl, toGeoJson } = await import('geoparquet')
28-
29-
const file = asyncBufferFromUrl({ url: 'example.parquet' })
30-
const geoJson = toGeoJson({ file })
31-
```
32-
3343
## Demo
3444

3545
Check out the [live demo](https://hyparam.github.io/geoparquet/) to see GeoParquet in action.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "geoparquet",
3-
"version": "0.5.0",
3+
"version": "0.6.0",
44
"description": "A library for reading geospatial data in Apache Parquet format",
55
"author": "Hyperparam",
66
"homepage": "https://hyperparam.app",

0 commit comments

Comments
 (0)