Skip to content

Commit 99e96fc

Browse files
committed
Update the ReadMe
1 parent 39cdd32 commit 99e96fc

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,16 @@ All-in-one framework for fast & simple browser automation and end-to-end testing
66

77
SeleniumBase uses [pytest](https://github.com/pytest-dev/pytest) for running tests, while using [Selenium WebDriver](https://www.seleniumhq.org/) for controlling web browsers.<br />
88

9-
Watch [my_first_test.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py) from [examples/](https://github.com/seleniumbase/SeleniumBase/tree/master/examples) running in demo mode:<br />
10-
11-
<img src="https://cdn2.hubspot.net/hubfs/100006/images/my_first_test_mov4.gif" title="SeleniumBase" />
12-
9+
Run [my_first_test.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py) in Demo Mode to see test assertions:
1310
```bash
14-
pytest my_first_test.py --demo_mode
11+
pytest my_first_test.py --demo
1512
```
1613

17-
Here's the code of [my_first_test.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py):
14+
<img src="https://cdn2.hubspot.net/hubfs/100006/images/my_first_test_mov4.gif" title="SeleniumBase" />
1815

19-
<img src="https://cdn2.hubspot.net/hubfs/100006/images/my_first_test_4.png" title="SeleniumBase" />
16+
<img src="https://cdn2.hubspot.net/hubfs/100006/images/my_first_test_7.png" title="SeleniumBase" />
2017

21-
SeleniumBase includes additional tools for automated [visual testing](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/visual_testing/ReadMe.md), assisted-QA with [MasterQA](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md), and creating [website tours](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md).
18+
SeleniumBase includes tools for automated [visual testing](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/visual_testing/ReadMe.md), assisted-QA with [MasterQA](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md), and creating [website tours](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md).
2219

2320
## <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Get Started:
2421

@@ -162,10 +159,10 @@ With Pytest, a green dot means a test passed. An "F" means a test failed.
162159

163160
<a id="seleniumbase_demo_mode"></a> **Use Demo Mode to help you see what tests are asserting.**
164161

165-
If the example test is moving too fast for your eyes, you can run it in **Demo Mode** by adding ``--demo_mode`` on the command-line, which pauses the browser briefly between actions, highlights page elements being acted on, and lets you know what test assertions are happening in real time:
162+
If the example test is moving too fast for your eyes, you can run it in **Demo Mode** by adding ``--demo`` on the command-line, which pauses the browser briefly between actions, highlights page elements being acted on, and lets you know what test assertions are happening in real time:
166163

167164
```bash
168-
pytest my_first_test.py --demo_mode
165+
pytest my_first_test.py --demo
169166
```
170167

171168
**Pytest** includes test discovery. If you don't specify a specific file or folder to run from, ``pytest`` will search all subdirectories automatically for tests to run based on the following matching criteria:
@@ -221,7 +218,7 @@ SeleniumBase provides additional Pytest command-line options for tests:
221218
--start_page=URL # (The starting URL for the web browser when tests begin.)
222219
--log_path=LOG_PATH # (The directory where log files get saved to.)
223220
--archive_logs # (Archive old log files instead of deleting them.)
224-
--demo_mode # (The option to visually see test actions as they occur.)
221+
--demo # (The option to visually see test actions as they occur.)
225222
--demo_sleep=SECONDS # (The option to wait longer after Demo Mode actions.)
226223
--highlights=NUM # (Number of highlight animations for Demo Mode actions.)
227224
--message_duration=SECONDS # (The time length for Messenger alerts.)

0 commit comments

Comments
 (0)