Skip to content

Commit

Permalink
Clarified the purpose of Origin.update.
Browse files Browse the repository at this point in the history
  • Loading branch information
Robert Hurst authored and Robert Hurst committed Jan 31, 2012
1 parent 14bddae commit f9e6879
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions readme.md
Expand Up @@ -126,9 +126,8 @@ Update

Origin.update();

The `Origin.update` method should never need to be called, however in the event that something weird happens, for example
your application looses focus on a hash change event, calling this function will force Origin to re check the hash and
execute matching routes.
The `Origin.update` method is used to trigger force Origin to match the current hash url routes are defined. You should
call this after your routes are binded in your appication. You should only need to to call this function once.

Credits
=======
Expand Down

0 comments on commit f9e6879

Please sign in to comment.