From d802b4bfa6dbb0bbc4a60f6783a61f0318cc9163 Mon Sep 17 00:00:00 2001 From: Michael Mintz Date: Fri, 28 Dec 2018 12:08:57 -0500 Subject: [PATCH] Update the ReadMe --- README.md | 28 +++++++++------------------- 1 file changed, 9 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 499f5e15..4dace1db 100755 --- a/README.md +++ b/README.md @@ -4,7 +4,10 @@ Reliable Browser Automation & Testing with [Selenium-WebDriver](https://www.seleniumhq.org/) and [Pytest](https://docs.pytest.org/en/latest/). - +
+``` +pytest examples/my_first_test.py --demo_mode +``` ## Quick Start: @@ -35,32 +38,19 @@ python setup.py install seleniumbase install chromedriver ``` +* (You need a different web driver for each web browser you want to run automation on: ``chromedriver`` for Chrome, ``edgedriver`` for Edge, ``geckodriver`` for Firefox, ``operadriver`` for Opera, and ``iedriver`` for Internet Explorer.) + #### Run a test on Chrome: ``` cd examples pytest my_first_test.py --browser=chrome ``` -* (You need a different web driver for each web browser you want to run automation on: ``chromedriver`` for Chrome, ``edgedriver`` for Edge, ``geckodriver`` for Firefox, ``operadriver`` for Opera, and ``iedriver`` for Internet Explorer.) +* (Chrome is the default browser if not specified with ``--browser``) -SeleniumBase has a very flexible [command line interface](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md) to change how your tests run. - -Try out Demo Mode to see what what's being tested in real time! (Chrome is the default browser if not specified.) - -``` -pytest my_first_test.py --demo_mode -``` - -
-(Above: Actual demo of [my_first_test.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py) running on [xkcd.com](https://xkcd.com/353/)) - -There are many more examples to try out from the [SeleniumBase/examples](https://github.com/seleniumbase/SeleniumBase/blob/master/examples) folder, which you can run easily if you clone SeleniumBase. - - - -Check out [SeleniumBase Website Tours](https://github.com/seleniumbase/SeleniumBase/tree/master/examples/tour_examples) (in the ``examples/tour_examples`` folder). It's the most efficient website onboarding experience available (and it's free too). Find the [Tours ReadMe here](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md). +Check out [SeleniumBase Website Tours](https://github.com/seleniumbase/SeleniumBase/tree/master/examples/tour_examples) (in the ``examples/tour_examples`` folder). It's great for prototyping a website onboarding experience. See the [Tours ReadMe](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md) for more details. ``` cd tour_examples @@ -182,7 +172,7 @@ seleniumbase install edgedriver ### **Step 5:** Run the Example Script -**Here's what the example script looks like:** +**Here's what the example script, [my_first_test.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py), looks like:** ```python from seleniumbase import BaseCase