Merge pull request #443 from seleniumbase/docs-update

Update several ReadMe files

Author: mdmintz

README.md

@@ -1,13 +1,13 @@
-[<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_sb4.png" title="SeleniumBase" height="48">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
+[<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_sb10.png" title="SeleniumBase" height="48">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
 
 [<img src="https://img.shields.io/github/release/seleniumbase/SeleniumBase.svg" alt=" " />](https://github.com/seleniumbase/SeleniumBase/releases) [<img src="https://dev.azure.com/seleniumbase/seleniumbase/_apis/build/status/seleniumbase.SeleniumBase?branchName=master" alt=" " />](https://dev.azure.com/seleniumbase/seleniumbase/_build/latest?definitionId=1&branchName=master) [<img src="https://travis-ci.org/seleniumbase/SeleniumBase.svg?branch=master" alt=" " />](https://travis-ci.org/seleniumbase/SeleniumBase) [<img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt=" " />](https://gitter.im/seleniumbase/SeleniumBase) [<img src="https://img.shields.io/badge/license-MIT-22BBCC.svg" alt=" " />](https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE) [<img src="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg" alt=" " />](https://github.com/seleniumbase/SeleniumBase/stargazers)
 
 All-in-one framework for web automation, end-to-end testing, and website tours. SeleniumBase uses [pytest](https://pytest.org) for running Python scripts, while using [Selenium WebDriver](https://selenium.dev/) for controlling web browsers.
 
-* Helps you build reliable, non-flaky UI tests for any website.
+* Helps you quickly build reliable tests for any website.
+* Uses easy-to-learn [Python methods](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md) for writing tests.
 * Includes flexible [command-line options](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md) for running tests.
-* Comes with easy-to-use [Python methods](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md) for writing tests.
-* Includes tools for [assisted-QA](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md), [visual testing](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/visual_testing/ReadMe.md), and [web tours](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md).
+* Includes tools for [assisted-QA](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md), [visual testing](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/visual_testing/ReadMe.md), & [web tours](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md).
 * Integrates with [Selenium Grid](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md), [Katalon Recorder](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_ide/ReadMe.md), and more.
 * To see the full list of SeleniumBase features, [click here](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/features_list.md).
 

examples/ReadMe.md

@@ -10,7 +10,7 @@ During test failures, logs and screenshots from the most recent test run will ge
 
 **Here are some example run commands to help get you started:**
 
-Run an example test in Chrome (``--browser=chrome`` is the default):
+Run an example test in Chrome: (``--browser=chrome`` is the default)
 ```bash
 pytest my_first_test.py
 ```
@@ -20,61 +20,76 @@ Run an example test in Firefox:
 pytest my_first_test.py --browser=firefox
 ```
 
-Run an example test in Demo Mode (highlights page objects being acted on):
+Run an example test in Demo Mode: (highlight assertions)
 ```bash
 pytest my_first_test.py --demo
 ```
 
-Run an example test demonstrating parameterization:
+Run an example test in Headless Mode: (invisible web browser)
 ```bash
-pytest parameterized_test.py
+pytest my_first_test.py --headless
 ```
 
-Run an example test suite and generate an pytest report: (pytest-only)
+Run tests multi-threaded using [n] threads:
 ```bash
-pytest test_suite.py --html=report.html
+pytest test_suite.py -n=4
 ```
 
-Run an example test suite and generate a nosetest report: (nosetests-only)
+Run a parameterized test, which generates multiple tests out of one:
 ```bash
-nosetests test_suite.py --report --show-report
+pytest parameterized_test.py
 ```
 
-Run an example test using a nosetest configuration file: (nosetests-only)
+Run an example test suite and generate a pytest report: (pytest-only)
 ```bash
-nosetests my_first_test.py --config=example_config.cfg
+pytest test_suite.py --html=report.html
 ```
 
-Run a test demonstrating the use of SeleniumBase Python decorators available:
+Run a failing test: (See the ``latest_logs/`` folder for logs and screenshots)
 ```bash
-pytest rate_limiting_test.py
+pytest test_fail.py
 ```
 
-Run a failing test: (See the ``latest_logs/`` folder afterwards for logs and screenshots)
+Run an example test using Chrome's mobile device emulator: (default settings)
 ```bash
-pytest test_fail.py
+pytest test_swag_labs.py --mobile
 ```
 
-Run a failing test with Debugging-mode enabled: (If a test failure occurs, pdb activates)
+Run a failing test with Debug-mode enabled: (``pdb`` activates on failures)
 ```bash
 pytest test_fail.py --pdb -s
 ```
 
+Run an example test suite that demonstrates the use of pytest markers:
+```bash
+pytest -v -m marker_test_suite
+```
+
 Run an example test suite that reuses the browser session between tests:
 ```bash
 pytest test_suite.py --reuse-session
 ```
 
-Run an example test suite that demonstrates the use of pytest markers:
+Run an example test demonstrating the ``rate_limited`` Python decorator:
 ```bash
-pytest -v -m marker_test_suite
+pytest rate_limiting_test.py
 ```
 
-Run a test that demonstrates how to upload a file to a website:
+Run an example test that demonstrates how to upload a file to a website:
 ```bash
 pytest upload_file_test.py
 ```
 
+Run an example test suite and generate a nosetest report: (nosetests-only)
+```bash
+nosetests test_suite.py --report --show-report
+```
+
+Run an example test using a nosetest configuration file: (nosetests-only)
+```bash
+nosetests my_first_test.py --config=example_config.cfg
+```
+
 For more advanced run commands, such as using a proxy server, see [../help_docs/customizing_test_runs.md](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md)
 
 --------

help_docs/customizing_test_runs.md

@@ -13,11 +13,11 @@ pytest my_first_test.py
 # Run my_first_test.py in Firefox
 pytest my_first_test.py --browser=firefox
 
-# Run tests in Demo Mode to see assertions
+# Run a test in Demo Mode (highlight assertions)
 pytest my_first_test.py --demo
 
-# Run tests in Headless Mode (invisible browser)
-pytest test_suite.py --headless
+# Run a test in Headless Mode (invisible browser)
+pytest my_first_test.py --headless
 
 # Run tests multi-threaded using [n] threads
 pytest test_suite.py -n=4

help_docs/features_list.md

@@ -13,9 +13,11 @@
 * Has [Plugins](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/plugins) for logging data and screenshots automatically. ([Click to learn more](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md))
 * Uses a [global config file](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/config/settings.py) for configuring SeleniumBase to your specific needs.
 * Backwards-compatible with [WebDriver](http://www.seleniumhq.org/projects/webdriver/). (Use ``self.driver`` anywhere.)
+* Can run tests in Headless Mode to hide the web browser. (Use ``--headless``)
 * Can run tests through a proxy server. (Use ``--proxy=IP_ADDRESS:PORT``)
 * Can use an authenticated proxy server. (``--proxy=USERNAME:PASSWORD@IP_ADDRESS:PORT``)
 * Can change the web browser's user agent string. (Use ``--agent=USER_AGENT_STRING``)
+* Can run tests using Chrome's mobile device emulator (Use ``--mobile``)
 * Can set a Chrome User Data Directory / Profile to load. (Use ``--user_data_dir=DIR``)
 * Can load Chrome Extension ZIP files (comma-separated). (Use ``--extension_zip=ZIP``)
 * Can load Chrome Extension folders (comma-separated). (Use ``--extension_dir=DIR``)
@@ -24,5 +26,7 @@
 * Integrates with [MySQL](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/core/testcase_manager.py), [Selenium Grid](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/utilities/selenium_grid), [Azure](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/azure/jenkins/ReadMe.md), [Google Cloud](https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/google_cloud/ReadMe.md), [Amazon S3](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/plugins/s3_logging_plugin.py), and [Docker](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/docker/ReadMe.md).
 * Has the ability to connect to a [BrowserStack](https://www.browserstack.com/automate#), [Sauce Labs](https://saucelabs.com/products/web-testing/cross-browser-testing), or [TestingBot](https://testingbot.com/features) Selenium Grid.
 * Includes a [tool to convert Selenium IDE recordings](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/utilities/selenium_ide) into clean, robust SeleniumBase scripts.
-* Written in Python, but can also make JavaScript calls using ``self.execute_script()``.
+* Can load and make assertions on PDF files from websites or the local file system.
+* Can reuse the same Selenium browser session between tests. (Use: ``--reuse-session``)
+* Written in Python, but can also make JavaScript calls. (Use: ``self.execute_script()``)
 * Includes useful Python decorators and password obfuscation methods. ([Learn more here](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/common/ReadMe.md))