Added documentation for tour.removeStep (fixes #278) (#289)

shipshapecode · Oct 29, 2018 · 03ccd93 · 03ccd93
1 parent 49339e5
commit 03ccd93
Showing 1 changed file with 7 additions and 0 deletions.
diff --git 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