Skip to content

Commit 27f34ce

Browse files
committed
Update the Docs
1 parent b90629f commit 27f34ce

File tree

2 files changed

+18
-14
lines changed

2 files changed

+18
-14
lines changed

README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44

55
SeleniumBase extends [WebDriver](https://docs.microsoft.com/en-us/microsoft-edge/webdriver) into a complete framework for end-to-end testing with [Pytest](https://github.com/pytest-dev/pytest).
66

7-
**Quick Start in a few steps:** (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).)
7+
## Quick Start
8+
9+
(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).)
810

911
```
1012
python -m pip install --upgrade pip
@@ -52,16 +54,16 @@ For more detailed steps on getting started, see the [**Detailed Instructions**](
5254

5355
### Learn More:
5456

55-
**No more repetitive WebDriver code:**<br />
57+
#### **No more repetitive WebDriver code:**<br />
5658
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>)
5759

58-
**Simple Python syntax makes coding easy:**<br />
60+
#### **Simple Python syntax makes coding easy:**<br />
5961

6062
<img src="https://cdn2.hubspot.net/hubfs/100006/images/my_first_test_image.png" title="SeleniumBase Python Code" height="280">
6163

6264
(<i>By default, [CSS Selectors](https://www.w3schools.com/cssref/css_selectors.asp) are used for finding page elements.</i>)
6365

64-
**Run tests with Pytest or Nose in any browser:**<br />
66+
#### **Run tests with Pytest or Nose in any browser:**<br />
6567
(<i>Using **Pytest** is strongly recommended</i>)
6668

6769
```
@@ -72,7 +74,7 @@ nosetests my_test_suite.py --browser=firefox
7274

7375
Python methods that start with ``test_`` will automatically be run when using ``pytest`` or ``nosetests`` on a Python file, (<i>or on folders containing Python files</i>).
7476

75-
**No more messy code:**<br />
77+
#### **No more messy code:**<br />
7678
This long line of standard WebDriver code,
7779
```python
7880
self.driver.find_element_by_css_selector("textarea").send_keys("text")
@@ -83,22 +85,22 @@ self.update_text("textarea", "text")
8385
```
8486
(<i>You can still use ``self.driver`` in your code.</i>)
8587

86-
**No more flaky tests:**<br />
88+
#### **No more flaky tests:**<br />
8789
SeleniumBase methods automatically wait for page elements to finish loading before interacting with them (*up to a timeout limit*). This means you no longer need random ``time.sleep()`` statements in your code.
8890

89-
**Assist manual QA with automation:**<br />
91+
#### **Assist manual QA with automation:**<br />
9092
SeleniumBase includes an automated/manual hybrid solution called **[MasterQA](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/masterqa/ReadMe.md)**, which speeds up manual testing by having automation perform all the web browser actions while the manual tester only validates what is seen.
9193

92-
**Integrate with your favorite tools:**<br />
94+
#### **Integrate with your favorite tools:**<br />
9395
SeleniumBase is compatible with [Selenium Grid](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/utilities/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), [NodeJS](https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/node_js), [Google Cloud](https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/google_cloud/ReadMe.md), and [AWS](#amazon_section).
9496

95-
**Comes with a business mindset:**<br />
96-
SeleniumBase makes it easy to automate tedious business tasks. (*To learn about businesses using SeleniumBase, [Click Here](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/happy_customers.md).*)
97+
#### **Automate tedious business tasks:**<br />
98+
Beyond test automation, SeleniumBase is perfect for automating tedious business tasks that you would perform in a web browser.
9799

98-
**Extensively tested and made with love:**<br />
99-
SeleniumBase was originally built for [testing HubSpot's platform](https://product.hubspot.com/blog/bid/88880/Automated-Integration-Testing-with-Selenium-at-HubSpot) and automating business processes. In 2014, SeleniumBase was open-sourced and spun off as its own independent entity to benefit users everywhere.
100+
#### **Lots of Happy Customers:**<br />
101+
(*To learn about businesses using SeleniumBase, [Click Here](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/happy_customers.md).*)
100102

101-
**Feature-Rich:**<br />
103+
#### **Feature-Rich:**<br />
102104
([Read more about SeleniumBase features here](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/features_list.md))
103105

104106
<a id="seleniumbase_installation"></a>
@@ -252,6 +254,8 @@ Now you can install webdrivers by doing this:
252254
seleniumbase install chromedriver
253255
seleniumbase install geckodriver
254256
seleniumbase install edgedriver
257+
seleniumbase install iedriver
258+
seleniumbase install operadriver
255259
```
256260

257261
Remember, you'll need chromedriver if you want to run automation on Chrome, geckodriver if you want to run automation on Firefox, edgedriver for Microsoft Edge, etc.

help_docs/virtualenv_instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ export WORKON_HOME=$HOME/.virtualenvs
1111
source /usr/local/bin/virtualenvwrapper.sh
1212
```
1313

14-
If you add ``source /usr/local/bin/virtualenvwrapper.sh`` to your local bash file (``~/.bash_profile`` on a Mac, or ``~/.bashrc`` on Linux), virtualenvwrapper commands will be available whenever you open a new command prompt. Use the ``source`` command on those files to activate any changes you make.
14+
If you add ``source /usr/local/bin/virtualenvwrapper.sh`` to your local bash file (``~/.bash_profile`` on a Mac, or ``~/.bashrc`` on Linux), virtualenvwrapper commands will be available whenever you open a new command prompt.
1515

1616
### WINDOWS:
1717

0 commit comments

Comments
 (0)