Skip to content

Commit

Permalink
readme, alternative floor syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
nrkn committed Oct 24, 2015
1 parent ab4f6af commit 06fe89f
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,23 @@ You can also get verbose output (for checking your size and steps):
const info = hrm( source, inbox, floor, true )
```

If you want verbose output but have no floor, pass an empty array or object:

```javascript
const info = hrm( source, inbox, {}, true )
```

There is also an alternative floor syntax to allow the use of data from
[hrm-level-data](https://github.com/atesgoral/hrm-level-data/blob/master/hrm-level-data-schema.json):

```javascript
const floor = {
tiles: {
9: 0
}
}
```

### License

MIT

0 comments on commit 06fe89f

Please sign in to comment.