Skip to content

Commit 212fdd7

Browse files
committed
Update a ReadMe
1 parent 1124408 commit 212fdd7

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

examples/tour_examples/ReadMe.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
## Using SeleniumBase Tours
1+
## Creating SeleniumBase Tours
2+
3+
![](https://cdn2.hubspot.net/hubfs/100006/images/google_tour.gif "SeleniumBase Tours")<br>
24

35
SeleniumBase Tours utilize the [HubSpot Shepherd Library](http://github.hubspot.com/shepherd/docs/welcome/) for creating and running tours on any website.
46

@@ -12,7 +14,7 @@ To utilize tours, there are three methods that you need to know at the basic lev
1214

1315
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``.
1416

15-
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 the tour message will 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 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).
1618

1719
Finally, you can play a tour you created by calling the ``self.play_tour()`` method.
1820

0 commit comments

Comments
 (0)