Skip to content

Commit 1b0b90b

Browse files
committed
minor readme updates
1 parent 82cc07a commit 1b0b90b

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

README.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,13 @@
22

33
A really fast **static spatial index** for 2D points and rectangles in JavaScript.
44

5-
An efficient implementation of the [packed Hilbert R-tree](https://en.wikipedia.org/wiki/Hilbert_R-tree#Packed_Hilbert_R-trees) algorithm. Enables fast spatial queries on a very large number of objects (e.g. millions), which is very useful in maps, data visualizations and computational geometry algorithms.
6-
7-
Similar to [RBush](https://github.com/mourner/rbush), with the following key differences:
5+
An efficient implementation of the [packed Hilbert R-tree](https://en.wikipedia.org/wiki/Hilbert_R-tree#Packed_Hilbert_R-trees) algorithm. Enables fast spatial queries on a very large number of objects (e.g. millions), which is very useful in maps, data visualizations and computational geometry algorithms. Similar to [RBush](https://github.com/mourner/rbush), with the following key differences:
86

97
- **Static**: you can't add/remove items after initial indexing.
108
- **Faster** indexing and search, with much lower **memory** footprint.
11-
- Index is stored as a single **array buffer** (so you can [transfer](https://developer.mozilla.org/en-US/docs/Glossary/Transferable_objects) it between threads or store it as a compact binary file).
9+
- Index is stored as a single **array buffer** (to [transfer](https://developer.mozilla.org/en-US/docs/Glossary/Transferable_objects) between threads or save as a compact binary file).
1210

13-
Supports geographic locations with the [geoflatbush](https://github.com/mourner/geoflatbush) extension.
11+
Supports geographic locations with the [geoflatbush](https://github.com/mourner/geoflatbush) extension. See also: [KDBush](https://github.com/mourner/kdbush), a similar library for points.
1412

1513
[![Build Status](https://github.com/mourner/flatbush/workflows/Node/badge.svg?branch=main)](https://github.com/mourner/flatbush/actions) [![minzipped size](https://badgen.net/bundlephobia/minzip/flatbush)](https://esm.run/flatbush) [![Simply Awesome](https://img.shields.io/badge/simply-awesome-brightgreen.svg)](https://github.com/mourner/projects)
1614

@@ -112,7 +110,7 @@ const ids = index.neighbors(10, 10, 5); // returns 5 ids
112110
`maxResults` and `maxDistance` are `Infinity` by default.
113111
Also accepts a `filterFn` similar to `index.search`.
114112

115-
#### `Flatbush.from(data)`
113+
#### `Flatbush.from(data[, byteOffset])`
116114

117115
Recreates a Flatbush index from raw `ArrayBuffer` or `SharedArrayBuffer` data
118116
(that's exposed as `index.data` on a previously indexed Flatbush instance).

0 commit comments

Comments
 (0)