Skip to content

Commit 1e4e75f

Browse files
committed
Update walkthrough tour ReadMe
1 parent 068eb5a commit 1e4e75f

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

examples/tour_examples/ReadMe.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,21 @@
22

33
![](https://cdn2.hubspot.net/hubfs/100006/images/google_tour.gif "SeleniumBase Tours")<br>
44

5-
SeleniumBase Tours utilize the [HubSpot Shepherd Library](http://github.hubspot.com/shepherd/docs/welcome/) for creating and running tours on any website.
5+
SeleniumBase Tours utilize the [HubSpot Shepherd Library](http://github.hubspot.com/shepherd/docs/welcome/) for creating and running tours, demos, and walkthroughs on any website.
66

77
To utilize tours, there are three methods that you need to know at the basic level (which contain optional arguments):
88

99
``self.create_tour(theme)``
1010

1111
``self.add_tour_step(message, css_selector, title, alignment, theme)``
1212

13-
``self.play_tour()``
13+
``self.play_tour(interval)``
1414

1515
With the ``create_tour()`` method, you can pass a default theme to change the look & feel of the tour steps. Valid themes are ``dark``, ``default``, ``arrows``, ``square``, and ``square-dark``.
1616

17-
With the ``self.add_tour_step()`` method, at minimum you must pass a message to display. Then you can specify a web element to attach to (by CSS selector). If no element is specified, the tour step will tether to the top of the screen by default. You can add an optional title above the message to display with the tour step. You can also change the theme for that step, as well as specifiy the alignment (which is the side of the element that you want the tour message to tether to).
17+
With the ``self.add_tour_step()`` method, at minimum you must pass a message to display. Then you can specify a web element to attach to (by CSS selector). If no element is specified, the tour step will tether to the top of the screen by default. You can also add an optional title above the message to display with the tour step, as well as change the theme for that step, and even specify the alignment (which is the side of the element that you want the tour message to tether to).
1818

19-
Finally, you can play a tour you created by calling the ``self.play_tour()`` method.
19+
Finally, you can play a tour you created by calling the ``self.play_tour()`` method. If you specify an interval, the tour will automatically walk through each step after that many seconds have passed.
2020

2121
### Here's an example of using SeleniumBase Tours:
2222

0 commit comments

Comments
 (0)