Commit 198098b7 authored by Chris Scott's avatar Chris Scott

Update README.md

parent c5460a35
...@@ -655,21 +655,21 @@ The plugin now includes native geofencing features. You may add, remove and que ...@@ -655,21 +655,21 @@ The plugin now includes native geofencing features. You may add, remove and que
A monitored geofence will persit until you explicity remove it via `bgGeo.removeGeofence("Home")`. A monitored geofence will persit until you explicity remove it via `bgGeo.removeGeofence("Home")`.
### Geofence Model #### Geofence Model
####`@param {String} identifier` #####`@param {String} identifier`
A unique `String` to identify your Geofence, eg: "Home", "Office". A unique `String` to identify your Geofence, eg: "Home", "Office".
####`@param {Integer} radius` #####`@param {Integer} radius`
The radius of the circular geofence. A radius of >100 meters works best. The radius of the circular geofence. A radius of >100 meters works best.
####`@param {Boolean} notifyOnEntry` #####`@param {Boolean} notifyOnEntry`
Transitioning **into** the geofence will generate an event. Transitioning **into** the geofence will generate an event.
####`@param {Boolean} notifyOnExit` #####`@param {Boolean} notifyOnExit`
Transitioning **out of** the geofence will generate an event. Transitioning **out of** the geofence will generate an event.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment