From 03ccd939c067e8ffb5ba9324959a617fbdab58f9 Mon Sep 17 00:00:00 2001 From: Joe Innes Date: Mon, 29 Oct 2018 16:23:20 +0100 Subject: [PATCH] Added documentation for tour.removeStep (fixes #278) (#289) --- index.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/index.md b/index.md index 451aeed76..d1d69f88e 100644 --- a/index.md +++ b/index.md @@ -67,6 +67,13 @@ Finally, to start the tour, just call `start` on your `Tour` instance: tour.start(); ``` +If you need to remove a step from your tour, call `removeStep` on your `Tour` instance. If the step currently being displayed is the one you're removing, and there are steps left in the tour, then the first one will be shown, otherwise, the tour will be cancelled. + +```javascript +tour.removeStep('example-step'); +``` + + ### API #### Global Shepherd Object