Update Docs

Author: mdmintz

README.md

@@ -1,7 +1,7 @@
 # SeleniumBase
 [![pypi](https://img.shields.io/pypi/v/seleniumbase.svg)](https://pypi.python.org/pypi/seleniumbase) [![Build Status](https://travis-ci.org/seleniumbase/SeleniumBase.svg?branch=master)](https://travis-ci.org/seleniumbase/SeleniumBase) [![Python version](https://img.shields.io/badge/python-2.7,_3.*-22AADD.svg "Python version")](https://docs.python.org/2/) [![MIT License](http://img.shields.io/badge/license-MIT-22BBCC.svg "MIT License")](https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE) [![Join the chat at https://gitter.im/seleniumbase/SeleniumBase](https://badges.gitter.im/seleniumbase/SeleniumBase.svg)](https://gitter.im/seleniumbase/SeleniumBase?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![GitHub stars](https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg "GitHub stars")](https://github.com/seleniumbase/SeleniumBase/stargazers)
 
-Fast & reliable test automation. Runs with [Pytest](https://docs.pytest.org/en/latest/) & [Nosetests](http://nose.readthedocs.io/en/latest/). [Jenkins](https://jenkins.io/)-friendly.
+Reliable test automation. [Built-in logging & reports](https://github.com/seleniumbase/SeleniumBase/tree/master/examples/example_logs). Runs with [Pytest](https://docs.pytest.org/en/latest/) or [Nosetest](http://nose.readthedocs.io/en/latest/).
 
 <b>Simple [Python](https://www.python.org/) code speeds development:</b><br>
 

_config.yml

@@ -1,3 +1,3 @@
 theme: jekyll-theme-cayman
 title: SeleniumBase
-description: Test Automation for The Web has evolved
+description: The missing test framework for Selenium

examples/example_logs/ReadMe.md

@@ -0,0 +1,40 @@
+### Logging & Reports Tutorial
+
+The log files you see in this folder were generated when [test_fail.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_fail.py) ran and failed with logging turned on. (Include ``--with-testing_base`` on the command line in your test runs.) By default, a folder named ``latest_logs/`` will appear in the location where you ran the tests. If you have ARCHIVE_EXISTING_LOGS set to True in [settings.py](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/config/settings.py), past logs will get moved to the ``archived_logs/`` folder instead of getting deleted.
+
+**Usage examples:**
+```bash
+pytest test_fail.py --with-testing_base --browser=chrome
+
+nosetests test_fail.py --with-selenium --with-testing_base --browser=firefox
+```
+
+**Expected log files generated during failures:**
+[basic_test_info.txt](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/basic_test_info.txt)
+[page_source.html](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/page_source.html)
+[screenshot.png](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/screenshot.png)
+
+---
+**In addition to logging, you can also generate test reports:**
+
+Reports are most useful when running large test suites. Pytest and Nosetest reports are handled differently.
+
+#### **Pytest Reports:**
+
+Using ``--html=report.html`` gives you a fancy report of the name specified after your test suite completes.
+
+```bash
+pytest my_test_suite.py --with-selenium --html=report.html
+```
+![](https://cdn2.hubspot.net/hubfs/100006/images/PytestReport.png "Example Pytest Report")
+
+#### **Nosetest Reports:**
+
+The ``--report`` option gives you a fancy report after your test suite completes. (Requires ``--with-testing_base`` to also be set when ``--report`` is used because it's part of that plugin.)
+
+```bash
+nosetests my_test_suite.py --with-selenium --with-testing_base --report --browser=chrome
+```
+![](http://cdn2.hubspot.net/hubfs/100006/images/Test_Report_2.png "Example Nosetest Report")
+
+(NOTE: You can add ``--show_report`` to immediately display the report after the test suite completes. You don't want to use this when running tests remotely because otherwise the test run will hang indefinitely until someone manually exits the report.)

examples/example_logs/ReadMe.txt

@@ -1,11 +1,12 @@
 <a id="feature_list"></a>
 ### ![http://seleniumbase.com](https://cdn2.hubspot.net/hubfs/100006/images/super_logo_tiny.png "SeleniumBase") **SeleniumBase Features:**
 * A versatile test automation framework for building & running reliable Selenium scripts.
-* A hybrid-automation solution called **[MasterQA](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/masterqa/ReadMe.md)** for speeding up manual testing.
-* [Python libraries](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase) for helping you do more with Selenium-WebDriver.
-* A flexible command line interface for customizing test runs.
-* [Plugins](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/plugins) for logging [data and screenshots](https://github.com/seleniumbase/SeleniumBase/tree/master/examples/example_logs) automatically.
-* [A global config file](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/config/settings.py) for making SeleniumBase unique to your specific environmental needs.
-* Easy integration with [Selenium Grid](https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/selenium_grid), [MySQL](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/core/testcase_manager.py), [Docker](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/docker/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 [NodeJS](https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/node_js).
+* Run tests locally, from [Jenkins](https://jenkins.io/) headlessly, or remotely with [Selenium Grid](https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/selenium_grid).
+* Uses a flexible command line interface for customizing test runs.
+* Has [Python libraries](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase) for helping you do more with Selenium-WebDriver.
+* Has [Plugins](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/plugins) for logging [data and screenshots](https://github.com/seleniumbase/SeleniumBase/tree/master/examples/example_logs) automatically.
+* Uses a [global config file](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/config/settings.py) for making SeleniumBase unique to your specific environmental needs.
+* Includes a hybrid-automation solution called **[MasterQA](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/masterqa/ReadMe.md)** to speed up manual testing.
+* Includes integrations with [MySQL](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/core/testcase_manager.py), [Docker](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/docker/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 [NodeJS](https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/node_js).
 * Backwards-compatible with [WebDriver](http://www.seleniumhq.org/projects/webdriver/). (Use ``self.driver`` anywhere.)
-* [A tool to convert Selenium IDE recordings](https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/selenium_ide) into clean & reliable SeleniumBase scripts.
+* Includes a [tool to convert Selenium IDE recordings](https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/selenium_ide) into clean & reliable SeleniumBase scripts.

help_docs/features_list.md

@@ -16,7 +16,7 @@ Now you can add a Grid Node to the Grid Hub:
 ```bash
 ./grid-node start
 ```
-(NOTE: If the Grid Node is not running on the same machine as the Grid Hub, update the address from the script.)
+(NOTE: If the Grid Node is not running on the same machine as the Grid Hub, update the address listed for WEBDRIVER_NODE_PARAMS in the [grid-node](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/selenium_grid/grid-node) script.)
 You should be able to see the Grid Console up and running from here: [http://0.0.0.0:4444/grid/console](http://0.0.0.0:4444/grid/console) (NOTE: That's the address if you're running locally from localhost.)
 
 You can remove a Grid Node from the Grid Hub with:
@@ -28,6 +28,10 @@ You can stop the Grid Hub at anytime with:
 ./grid-hub stop
 ```
 
+When running with nosetests, configure a "``setup.cfg``" file with your grid hub info. (See the example [selenium_server_config_example.cfg](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/selenium_grid/selenium_server_config_example.cfg) file.)
+
+When running with pytest, add the server and port info to a "``pytest.ini``" file. (Or add that data directly on the command line when you run your tests.)
+
 #### More detailed info about connecting to the Selenium Grid Hub can be found here:
 * [https://theintern.github.io/intern/#selenium-grid](https://theintern.github.io/intern/#selenium-grid)
 * [https://github.com/SeleniumHQ/selenium/wiki/Grid2](https://github.com/SeleniumHQ/selenium/wiki/Grid2)