Update README

This commit is contained in:
Kenny Daniel 2024-01-04 11:24:35 -08:00
parent 04bfd474b8
commit e0486e152a
No known key found for this signature in database
GPG Key ID: 6A3C5E318BE71391

@ -4,6 +4,7 @@
[![mit license](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![workflow status](https://github.com/hyparam/hyparquet/actions/workflows/ci.yml/badge.svg)](https://github.com/hyparam/hyparquet/actions)
[![npm](https://img.shields.io/npm/v/hyparquet)](https://www.npmjs.com/package/hyparquet)
JavaScript parser for [Apache Parquet](https://parquet.apache.org) files.
@ -11,6 +12,18 @@ Apache Parquet is an open source, column-oriented data file format designed for
Dependency free since 2023!
## Usage
```bash
npm install hyparquet
```
```js
import { parquetMetadata } from 'hyparquet'
const metadata = parquetMetdata(arrayBuffer)
```
## References
- https://github.com/apache/parquet-format