diff --git a/README.md b/README.md index 70b9c8d..0343369 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# Flechette +# Flechette **Flechette** is a JavaScript library for reading and writing the [Apache Arrow](https://arrow.apache.org/) columnar in-memory data format. It provides a faster, lighter, zero-dependency alternative to the [Arrow JS reference implementation](https://github.com/apache/arrow/tree/main/js). Flechette performs fast extraction and encoding of data columns in the Arrow binary IPC format, supporting ingestion of Arrow data from sources such as [DuckDB](https://duckdb.org/) and Arrow use in JavaScript data analysis tools like [Arquero](https://github.com/uwdata/arquero), [Mosaic](https://github.com/uwdata/mosaic), [Observable Plot](https://observablehq.com/plot/), and [Vega-Lite](https://vega.github.io/vega-lite/). -For documentation, see the [**API Reference**](https://idl.uw.edu/flechette/api). +For documentation, see the [**API Reference**](https://idl.uw.edu/flechette/api). For code, see the [**Flechette GitHub repo**](https://github.com/uwdata/flechette). ## Why Flechette? diff --git a/docs/api/column.md b/docs/api/column.md index 7249aab..671b906 100644 --- a/docs/api/column.md +++ b/docs/api/column.md @@ -1,7 +1,7 @@ --- title: Column | API Reference --- -# API Reference +# Flechette API Reference [Top-Level](/flechette/api) | [Data Types](data-types) | [Table](table) | [**Column**](column) diff --git a/docs/api/data-types.md b/docs/api/data-types.md index c672b5b..c954552 100644 --- a/docs/api/data-types.md +++ b/docs/api/data-types.md @@ -1,7 +1,7 @@ --- title: Data Types | API Reference --- -# API Reference +# Flechette API Reference [Top-Level](/flechette/api) | [**Data Types**](data-types) | [Table](table) | [Column](column) diff --git a/docs/api/index.md b/docs/api/index.md index ba6ff9a..9066ad8 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -1,7 +1,7 @@ --- title: API Reference --- -# API Reference +# Flechette API Reference [**Top-Level**](/flechette/api) | [Data Types](data-types) | [Table](table) | [Column](column) diff --git a/docs/api/table.md b/docs/api/table.md index db1d780..19a7fe5 100644 --- a/docs/api/table.md +++ b/docs/api/table.md @@ -1,7 +1,7 @@ --- title: Table | API Reference --- -# API Reference +# Flechette API Reference [Top-Level](/flechette/api) | [Data Types](data-types) | [**Table**](table) | [Column](column) diff --git a/docs/assets/logo.svg b/docs/assets/logo.svg new file mode 100644 index 0000000..bba1ba4 --- /dev/null +++ b/docs/assets/logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 410f80d..ab805a8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,8 +1,10 @@ +# Flechette + **Flechette** is a JavaScript library for reading and writing the [Apache Arrow](https://arrow.apache.org/) columnar in-memory data format. It provides a faster, lighter, zero-dependency alternative to the [Arrow JS reference implementation](https://github.com/apache/arrow/tree/main/js). Flechette performs fast extraction and encoding of data columns in the Arrow binary IPC format, supporting ingestion of Arrow data from sources such as [DuckDB](https://duckdb.org/) and Arrow use in JavaScript data analysis tools like [Arquero](https://github.com/uwdata/arquero), [Mosaic](https://github.com/uwdata/mosaic), [Observable Plot](https://observablehq.com/plot/), and [Vega-Lite](https://vega.github.io/vega-lite/). -For documentation, see the [**API Reference**](api). +For documentation, see the [**API Reference**](api). For code, see the [**Flechette GitHub repo**](https://github.com/uwdata/flechette). ## Why Flechette?