From 6c0efdd46feb5428d99d2b53cc30f7be18060f9b Mon Sep 17 00:00:00 2001 From: Josh Baker Date: Fri, 10 Jun 2016 14:52:11 -0700 Subject: [PATCH] updated DETECT option details to README --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e4cc55f9..73b40d3d 100644 --- a/README.md +++ b/README.md @@ -175,11 +175,13 @@ The server will notify the client if the `command` is `del | set | drop`. - `drop` notifies the client that the entire collection is dropped. - `set` notifies the client that an object has been added or updated, and when it's position is detected by the fence. -The `detect` may be `enter | exit | cross`. +The `detect` may be one of the following values. +- `inside` is when an object is inside the specified area. +- `outside` is when an object is outside the specified area. - `enter` is when an object that **was not** previously in the fence has entered the area. - `exit` is when an object that **was** previously in the fence has exited the area. -- `cross` is when an object that **was not** previously in the fence has entered and exited the area. +- `cross` is when an object that **was not** previously in the fence has entered **and** exited the area. ## Object types