Skip to content

Commit

Permalink
Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
mbostock committed Dec 18, 2015
1 parent d86b3c2 commit b1b88a7
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,17 @@ A [quadtree](https://en.wikipedia.org/wiki/Quadtree) is a two-dimensional recurs

## Installing

If you use NPM, `npm install d3-quadtree`. Otherwise, download the [latest release](https://github.com/d3/d3-quadtree/releases/latest).
If you use NPM, `npm install d3-quadtree`. Otherwise, download the [latest release](https://github.com/d3/d3-quadtree/releases/latest). The released bundle supports AMD, CommonJS, and vanilla environments. Create a custom build using [Rollup](https://github.com/rollup/rollup) or your preferred bundler. You can also load directly from [d3js.org](https://d3js.org):

```html
<script src="https://d3js.org/d3-quadtree.v0.1.min.js"></script>
```

In a vanilla environment, a `d3_quadtree` global is exported. [Try d3-quadtree in your browser.](https://tonicdev.com/npm/d3-quadtree)

## API Reference

<a name="quadtree" href="#quadtree">#</a> <b>quadtree</b>()
<a name="quadtree" href="#quadtree">#</a> d3_quadtree.<b>quadtree</b>()

Creates a new [quadtree factory](#_quadtree) with the default [*x*-accessor](#quadtree_x), [*y*-accessor](#quadtree_y) and [extent](#quadtree_extent). The returned factory function can be used to create any number of quadtrees from data.

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "d3-quadtree",
"version": "0.0.3",
"version": "0.1.0",
"description": "Two-dimensional recursive spatial subdivision.",
"keywords": [
"d3",
Expand All @@ -24,7 +24,7 @@
"prepublish": "npm run test && uglifyjs build/d3-quadtree.js -c -m -o build/d3-quadtree.min.js && rm -f build/d3-quadtree.zip && zip -j build/d3-quadtree.zip -- LICENSE README.md build/d3-quadtree.js build/d3-quadtree.min.js"
},
"devDependencies": {
"d3-arrays": "~0.3.1",
"d3-array": "~0.6.1",
"faucet": "0.0",
"rollup": "0.20.5",
"tape": "4",
Expand Down

0 comments on commit b1b88a7

Please sign in to comment.