From 396b6ef6a16e253eb243703dd7a9e52186bbe9fa Mon Sep 17 00:00:00 2001 From: rogeriopvl Date: Tue, 11 Sep 2018 00:57:00 +0100 Subject: [PATCH] docs: update README with new depths --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4d75d85..28cafd5 100644 --- a/README.md +++ b/README.md @@ -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.