Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
frederoni committed Dec 20, 2017
1 parent 585d897 commit 447dbf1
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,25 +160,25 @@ If you need additional flexibility, you can use the following building blocks to
1. How far along the step is the user?
1. Does the user need to be alerted about an upcoming maneuver?

The library compares the user from the route and decides upon each one of these parameters and acts accordingly. The developer is told what is happening behind the scenes via `NSNotification`.
The library compares the user from the route and decides upon each one of these parameters and acts accordingly. The developer is told what is happening behind the scenes via notifications.

### Guidance Notifications

This library relies heavily on `NSNotification`s for letting the developer know when events have occurred.
This library relies heavily on notifications for letting the developer know when events have occurred.

#### `RouteControllerProgressDidChange`
#### `.routeControllerProgressDidChange`

* Emitted when the user moves along the route. Notification contains 3 keys:
* `RouteControllerProgressDidChangeNotificationProgressKey` - `RouteProgress` - Current progress along route
* `RouteControllerProgressDidChangeNotificationLocationKey` - `CLLocation` - Current location
* `RouteControllerProgressDidChangeNotificationSecondsRemainingOnStepKey` - `Double` - Given users speed and location, this is the number of seconds left to the end of the step

#### `RouteControllerDidPassSpokenInstructionPoint`
#### `.routeControllerDidPassSpokenInstructionPoint`

* Emitted when user passes a point where instructions should be spoken. This indicates the user should be notified about the upcoming maneuver. You can find the instruction narrative in the `RouteProgress` object. Notification contains 1 key:
* `MBRouteControllerDidPassSpokenInstructionPointRouteProgressKey` - `RouteProgress` - Current progress along route
* `RouteControllerDidPassSpokenInstructionPointRouteProgressKey` - `RouteProgress` - Current progress along route

#### `RouteControllerShouldReroute`
#### `.routeControllerShouldReroute`

* Emitted when the user is off the route and should be rerouted. Notification contains 1 key:
* `RouteControllerNotificationShouldRerouteKey` - `CLLocation` - Last location of user
Expand Down

0 comments on commit 447dbf1

Please sign in to comment.