diff --git a/README.md b/README.md index 5747396..c2b3fd7 100644 --- a/README.md +++ b/README.md @@ -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