docs: add documentation for ARMA filter

sestienne · May 12, 2019 · f153474 · f153474
1 parent 725ad2b
commit f153474
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -32,6 +32,9 @@
  * Region Monitoring (or geo fencing), works in all app states. 
  * Advertising device as an iBeacon
 
+#### Features exclusive to Android
+ * ARMA filter for distance calculations
+
 ### Installation
 
 ```
@@ -348,6 +351,12 @@ cordova.plugins.locationManager.startMonitoringForRegion(beaconRegion)
 
 ```
 
+##### Enable ARMA filter for distance calculations (Android only)
+
+The underlying library uses the moving average to calculate distance by default, but an ARMA filter can be enabled which will weigh more recent measurements higher than older measurements. It can be enabled by adding the following preference to your `config.xml` file:
+
+```<preference name="com.unarin.cordova.beacon.android.altbeacon.EnableArmaFilter" value="true" />```
+
 ## Contributions
 
 > Contributions are welcome at all times, please make sure that the tests are running without errors