Skip to content

Commit de8f06d

Browse files
committed
Update README with mascot image
1 parent 9ed534b commit de8f06d

File tree

5 files changed

+35
-7
lines changed

5 files changed

+35
-7
lines changed

README.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,42 @@
11
# GeoParquet
22

3+
![GeoParquet](geoparquet.jpg)
4+
35
[![npm](https://img.shields.io/npm/v/hyparquet)](https://www.npmjs.com/package/hyparquet)
46
[![minzipped](https://img.shields.io/bundlephobia/minzip/hyparquet)](https://www.npmjs.com/package/hyparquet)
7+
[![workflow status](https://github.com/hyparam/geoparquet/actions/workflows/ci.yml/badge.svg)](https://github.com/hyparam/geoparquet/actions)
58
[![mit license](https://img.shields.io/badge/License-MIT-orange.svg)](https://opensource.org/licenses/MIT)
9+
![coverage](https://img.shields.io/badge/Coverage-95-darkred)
10+
11+
**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.
12+
13+
## Why GeoParquet?
14+
15+
**GeoParquet** is an emerging standard for storing geospatial vector data in the columnar [Parquet](https://parquet.apache.org/) format. By leveraging Parquet’s columnar storage, GeoParquet files can be significantly more compact and faster to query than their GeoJSON equivalents, especially for large datasets. This can result in:
16+
17+
- **Smaller file sizes:** A GeoParquet file plus this lightweight library can often be much smaller than the equivalent GeoJSON, reducing bandwidth costs and improving load times.
18+
- **Faster loading:** Pure JavaScript parsing of Parquet files in the browser, with tiny package size means fast page load times.
19+
- **Seamless integration:** GeoParquet is based on well-established standards (GeoJSON, Parquet), ensuring broad compatibility and extensibility.
20+
21+
## Usage
22+
23+
Convert a GeoParquet file to GeoJSON:
24+
25+
```javascript
26+
const { asyncBufferFromUrl, toGeoJson } = import('geoparquet')
27+
28+
const file = asyncBufferFromUrl('example.parquet')
29+
const geoJson = toGeoJson({ file })
30+
```
631

7-
Convert geoparquet to geojson.
32+
## Demo
833

9-
Uses [hyparquet](https://github.com/hyparam/hyparquet) for tiny and fast parsing of parquet files in js.
34+
Check out the [live demo](https://hyparam.github.io/geoparquet/) to see GeoParquet in action.
1035

1136
## References
1237

13-
- GeoJSON: https://datatracker.ietf.org/doc/html/rfc7946
38+
- https://geoparquet.org/
1439
- https://github.com/opengeospatial/geoparquet
40+
- https://geojson.org/
41+
- https://datatracker.ietf.org/doc/html/rfc7946
42+
- https://github.com/hyparam/hyparquet

demo/bundle.min.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

demo/bundle.min.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

demo/demo.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ window.initMap = async function loadGeoParquet() {
88
const div = /** @type {HTMLElement} */(document.getElementById('map'))
99
// Create a new map
1010
map = new google.maps.Map(div, {
11-
center: { lat: 0, lng: 102 },
12-
zoom: 7,
11+
center: { lat: 39, lng: -98 },
12+
zoom: 4,
1313
})
1414

1515
// URL or path to your GeoParquet file

geoparquet.jpg

95.3 KB
Loading

0 commit comments

Comments
 (0)