Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jbeuckm committed Jan 23, 2014
1 parent 7e0cca5 commit 5380098
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,11 @@ TiBeacons.startAdvertisingBeacon({
});
```

Start scanning for iBeacons in one or more regions:
Start monitoring for iBeacons in one or more regions:

```javascript
TiBeacons.startRangingForBeacons({

TiBeacons.startMonitoringForRegion({
uuid : "00000000-0000-0000-0000-000000000000",
identifier : "Test Region 1",
});
Expand All @@ -41,6 +42,20 @@ TiBeacons.startRangingForBeacons({
});
```

Listen for region events:

```javascript
TiBeacons.addEventListener("enteredRegion", alert);
TiBeacons.addEventListener("exitedRegion", alert);
TiBeacons.addEventListener("determinedRegionState", alert);
```

If auto-ranging is enabled, the module will automatically start ranging when a region is entered.

```javascript
TiBeacons.enableAutoRanging();
```

Listen for the range events:

```javascript
Expand All @@ -57,5 +72,3 @@ TiBeacons.addEventListener("beaconProximity", function(e){
});
```

#### Coming soon: ####
I'm working now to implement the Monitoring API for iBeacons.

0 comments on commit 5380098

Please sign in to comment.