Skip to content

Commit f9d9663

Browse files
authored
Update README with 'Quick Start'
1 parent 98c08ac commit f9d9663

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

readMe.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,10 @@ modules, use as you would anything else.
1414
import TreeMap from 'replot-treemap'
1515
```
1616

17-
## API
17+
## Quick Start
1818
replot-treemap is designed to create beautiful treemaps right out of the box.
1919
The only *required* input is properly formatted data.
2020

21-
### Basic Usage
2221
In the simplest case, just supply data (as a Javascript array) and specify the
2322
keys for the titles and weights -:
2423

@@ -41,7 +40,7 @@ render() {
4140
- `titleKey` defaults to `"title"`
4241
- `weightKey` defaults to `"weight"`
4342

44-
### Advanced Usage - Nesting
43+
### Nesting
4544
Replot treemaps are able to display nested data, as long as the structure of the
4645
data is an proper flat format. If flat nested data is supplied, a `keyOrder`
4746
prop, which details titleKeys at various levels in the form of a Javascript
@@ -72,6 +71,8 @@ render() {
7271
}
7372
```
7473

74+
## API
75+
7576
### Dimensions
7677
Dimensions may be specified by passing in `width` and `height` props. The
7778
unit is pixels, and the treemap defaults to 800 by 400 pixels.

0 commit comments

Comments
 (0)