Skip to content

Commit ce5da2d

Browse files
committed
Update the Docs
1 parent 8c48448 commit ce5da2d

File tree

3 files changed

+16
-18
lines changed

3 files changed

+16
-18
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_2d1.png" title="SeleniumBase" height="48">
1+
[<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_2f1.png" title="SeleniumBase" height="48">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
22

33
[<img src="https://img.shields.io/pypi/v/seleniumbase.svg" alt="Version" />](https://pypi.python.org/pypi/seleniumbase) [<img src="https://img.shields.io/badge/python-2.7,_3.*-22AADD.svg" alt="Python versions" />](https://pypi.python.org/pypi/seleniumbase) [<img src="https://travis-ci.org/seleniumbase/SeleniumBase.svg?branch=master" alt="Build Status" />](https://travis-ci.org/seleniumbase/SeleniumBase) [<img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt="Join the Gitter Chat" />](https://gitter.im/seleniumbase/SeleniumBase) [<img src="http://img.shields.io/badge/license-MIT-22BBCC.svg" alt="MIT License" />](https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE) [<img src="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg" alt="GitHub Stars" />](https://github.com/seleniumbase/SeleniumBase/stargazers)<br />
44

5-
SeleniumBase transforms [WebDriver](https://www.seleniumhq.org/) into a complete test framework that runs with [Pytest](https://github.com/pytest-dev/pytest).
5+
### ![http://seleniumbase.com](https://cdn2.hubspot.net/hubfs/100006/images/super_logo_tiny.png "SeleniumBase") Automated Testing Made Easy
66

7-
## ![http://seleniumbase.com](https://cdn2.hubspot.net/hubfs/100006/images/super_logo_tiny.png "SeleniumBase") Quick Start
7+
SeleniumBase is a complete framework for end-to-end testing and [website walkthroughs](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md). It uses [WebDriver](https://www.seleniumhq.org/) to control web browsers while using [Pytest](https://github.com/pytest-dev/pytest) for running Python scripts.
8+
9+
## ![http://seleniumbase.com](https://cdn2.hubspot.net/hubfs/100006/images/super_logo_tiny.png "SeleniumBase") Quick Start in minutes
810

911
(Requires [Python](https://www.python.org/downloads/), [Git](https://git-scm.com/), and an optional [Python virtual environment](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/virtualenv_instructions.md).)
1012

@@ -52,7 +54,7 @@ pytest google_tour.py
5254

5355
For more detailed steps on getting started, see the [**Detailed Instructions**](#seleniumbase_installation) section.
5456

55-
### ![http://seleniumbase.com](https://cdn2.hubspot.net/hubfs/100006/images/super_logo_tiny.png "SeleniumBase") Learn More:
57+
## ![http://seleniumbase.com](https://cdn2.hubspot.net/hubfs/100006/images/super_logo_tiny.png "SeleniumBase") Learn More:
5658

5759
#### **No more repetitive WebDriver code:**<br />
5860
SeleniumBase automatically handles common WebDriver actions such as spinning up web browsers, waiting for page objects to load, saving screenshots during test failures, using a proxy server, and more. (<i>[Read about customizing test runs](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md).</i>)

_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
theme: jekyll-theme-cayman
22
title: SeleniumBase
3-
description: Web Automation & Testing Framework
3+
description: Automated Testing Made Easy

examples/tour_examples/ReadMe.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

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

5-
SeleniumBase Tours utilize the [Shepherd Library](https://cdnjs.com/libraries/shepherd/1.8.1) for creating and running tours, demos, and walkthroughs on any website.
5+
SeleniumBase Tours utilize the [Shepherd Javascript Library](https://cdnjs.com/libraries/shepherd/1.8.1) 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

@@ -14,7 +14,7 @@ To utilize tours, there are three methods that you need to know at the basic lev
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 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).
17+
With the ``self.add_tour_step()`` method, you must first pass a message to display. You can then specify a web element to attach to (by using [CSS selectors](https://www.w3schools.com/cssref/css_selectors.asp)). 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

1919
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

@@ -28,22 +28,18 @@ class MyTourClass(BaseCase):
2828
def test_google_tour(self):
2929
self.open('https://google.com')
3030
self.wait_for_element('input[title="Search"]')
31+
3132
self.create_tour(theme="dark")
32-
self.add_tour_step(
33-
"Click to begin the Google Tour!", title="SeleniumBase Tours")
34-
self.add_tour_step(
35-
"Type in your search query here.", 'input[title="Search"]')
36-
self.add_tour_step(
37-
"Then click here to search!", 'input[value="Google Search"]',
38-
alignment="bottom", theme="arrows")
39-
self.add_tour_step(
40-
"Or click here to see the top result.",
41-
'''[value="I'm Feeling Lucky"]''',
33+
self.add_tour_step("Click to begin the Google Tour!", title="SeleniumBase Tours")
34+
self.add_tour_step("Type in your search query here.", 'input[title="Search"]')
35+
self.add_tour_step("Then click here to search!", 'input[value="Google Search"]',
4236
alignment="bottom", theme="arrows")
37+
self.add_tour_step("Or click here to see the top result.",
38+
'''[value="I'm Feeling Lucky"]''', alignment="bottom", theme="arrows")
4339
self.play_tour()
4440
```
4541

46-
### This example was taken from [google_tour.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/google_tour.py), which you can run with:
42+
#### This example was taken from [google_tour.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/google_tour.py), which you can run from the ``examples/tour_examples`` folder with the following command:
4743

4844
```bash
4945
pytest google_tour.py

0 commit comments

Comments
 (0)