Skip to content
This repository has been archived by the owner on Feb 17, 2021. It is now read-only.

Commit

Permalink
Update README: add explanation for the getCurrTarget()
Browse files Browse the repository at this point in the history
  • Loading branch information
gnatok committed Sep 17, 2013
1 parent a6265d2 commit aaca52b
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Expand Up @@ -243,6 +243,8 @@ The Hopscotch framework comes with a simple set of API calls with which you can

* `hopscotch.getCurrTour()` - Returns the currently running tour.

* `hopscotch.getCurrTarget()` - Returns the target object of the currently running step.

* `hopscotch.getCurrStepNum()` - Returns the zero-based step number of the currently running tour.

* `hopscotch.getState()` - Checks for tour state saved in sessionStorage/cookies and returns the state if it exists. Use this method to determine whether or not you should resume a tour.
Expand Down

0 comments on commit aaca52b

Please sign in to comment.