search

mourner / rbush

RBush — a high-performance JavaScript R-tree-based 2D spatial index for points and rectangles
MIT License
2.46k stars 237 forks source link

"Usage" section of the README.md forgets to show where `RBush` comes from #97

Closed Pomax closed 4 years ago

Pomax commented 4 years ago

The usage section currently reads:

Creating a Tree const tree = new RBush();

But it's not clear where RBush comes from. Is this a const RBush = require("rbush");? Or is it the older const rbush = require("rbush"); const RBush = rbush.RBush;? or....?

Can the readme be updated to include the missing, but crucial, loading code?

Pomax commented 4 years ago

nice, thanks!