diff --git a/README.md b/README.md index b7147909..f47bb6e4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

Tile38

@@ -14,11 +14,11 @@ Tile38 is an open source (MIT licensed), in-memory geolocation data store, spati

This README is quick start document. You can find detailed documentation at https://tile38.com.

-Nearby -Within -Intersects -Geofencing -Roaming Geofences +Nearby +Within +Intersects +Geofencing +Roaming Geofences

## Features @@ -134,19 +134,19 @@ To set a field when an object already exists: Tile38 has support to search for objects and points that are within or intersects other objects. All object types can be searched including Polygons, MultiPolygons, GeometryCollections, etc. -Search Within +Search Within #### Within WITHIN searches a collection for objects that are fully contained inside a specified bounding area.
-Search Intersects +Search Intersects #### Intersects INTERSECTS searches a collection for objects that intersect a specified bounding area.
-Search Nearby +Search Nearby #### Nearby NEARBY searches a collection for objects that intersect a specified radius. @@ -157,12 +157,12 @@ NEARBY searches a collection for objects that intersect a specified radius. This is very helpful for example; when you have many (perhaps millions) of objects and do not want them all clustered together on a map. Sparse will limit the number of objects returned and provide them evenly distributed so that your map looks clean.

You can choose a value between 1 and 8. The value 1 will result in no more than 4 items. The value 8 will result in no more than 65536. *1=4, 2=16, 3=64, 4=256, 5=1024, 6=4098, 7=16384, 8=65536.*

- - - - - - + + + + + +
No SparsingSearch WithinSparse 1Search WithinSparse 2Search WithinSparse 3Search WithinSparse 4Search WithinSparse 5Search WithinNo SparsingSearch WithinSparse 1Search WithinSparse 2Search WithinSparse 3Search WithinSparse 4Search WithinSparse 5Search Within
*Please note that the higher the sparse value, the slower the performance. Also, LIMIT and CURSOR are not available when using SPARSE.* @@ -180,7 +180,7 @@ You can choose a value between 1 and 8. The value 1 will result in no more than ## Geofencing -Geofence animation +Geofence animation A geofence is a virtual boundary that can detect when an object enters or exits the area. This boundary can be a radius, bounding box, or a polygon. Tile38 can turn any standard search into a geofence monitor by adding the FENCE keyword to the search. *Tile38 also allows for [Webhooks](https://tile38.com/commands/sethook) to be assigned to Geofences.*