Skip to content

Commit

Permalink
docs: update README with new depths
Browse files Browse the repository at this point in the history
  • Loading branch information
rogeriopvl committed Sep 10, 2018
1 parent f499546 commit 396b6ef
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,17 @@ It also supports AMD.

With value `3` returns the 32 points of the compass.

With value `4` returns the 64 points of the compass.

With value `5` returns the 128 points of the compass.

Any other value will return `undefined`.

### Windrose.getDegrees(name, opts)

* `name` (string) the name or symbol of the compass point to convert to degrees
* `opts` (object) options hash [optional]
* `depth` (integer) the depth of search it can be a value between 0 and 3.
* `depth` (integer) the depth of search it can be a value between 0 and 5.

## License
Copyright (c) 2015 Rogério Vicente. Licensed under the MIT license.

0 comments on commit 396b6ef

Please sign in to comment.