Skip to content

Commit cd962e4

Browse files
committed
Update the ReadMe
1 parent a6701d4 commit cd962e4

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ Design and build reliable web automation with **SeleniumBase**'s all-in-one test
44

55
[![](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)<br /><br>
66

7-
<b>Take the hard work out of using WebDriver:</b><br>
7+
<b>Take the hard work out of using WebDriver:</b>
88
SeleniumBase automatically takes care of tedious WebDriver actions such as spinning up & closing web browsers, creating screenshots for failing tests, using a proxy server, connecting to a Selenium Grid, etc. (<i>[Read more](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/command_line.md)</i>)
99

10-
<b>Simple Python syntax makes coding easy:</b><br>
10+
<b>Simple Python syntax makes coding easy:</b>
1111
(<i>By default, [CSS Selectors](https://www.w3schools.com/cssref/css_selectors.asp) are used for finding page elements.</i>)
1212

1313
<img src="https://cdn2.hubspot.net/hubfs/100006/images/my_first_test_py_2.png" title="SeleniumBase Python Code" height="280">
@@ -24,7 +24,7 @@ nosetests my_test_suite.py --browser=firefox
2424
![](https://cdn2.hubspot.net/hubfs/100006/images/sb_demo.gif "SeleniumBase")<br>
2525
(<i>If you remove all the asserts from that test, you're left with [basic_script.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/basic_script.py), which performs all the actions you can see when running the test.</i>)
2626

27-
<b>No more messy code:</b><br>
27+
<b>No more messy code:</b>
2828
This long line of WebDriver code...
2929
```python
3030
self.driver.find_element_by_css_selector("textarea").send_keys("text")
@@ -35,30 +35,32 @@ self.update_text("textarea", "text")
3535
```
3636
(<i>You can still use ``self.driver`` in your code.</i>)
3737

38-
<b>No more flaky tests:</b><br>
38+
<b>No more flaky tests:</b>
3939
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.
4040

41-
<b>Assist manual QA with automation:</b><br>
41+
<b>Assist manual QA with automation:</b>
4242
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.
4343

44-
<b>Integrate with your favorite tools:</b><br>
44+
<b>Integrate with your favorite tools:</b>
4545
SeleniumBase is compatible 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), [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).
4646

47-
<b>Business mindset:</b><br>
47+
<b>Business mindset:</b>
4848
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).*)
4949

50-
<b>Extensive testing and made with love:</b><br>
50+
<b>Extensively tested and made with love:</b>
5151
SeleniumBase was originally built for [testing HubSpot's platform](https://product.hubspot.com/blog/the-classic-qa-team-is-obsolete) and automating business activites. Then in 2014, SeleniumBase was open-sourced to benefit users everywhere. It has grown significantly since then. For more HubSpot open-source projects, check out [github.com/hubspot](https://github.com/hubspot).
5252

53-
(<i>[Read more about SeleniumBase features](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/features_list.md)</i>)
53+
<b>Lots of additional features:</b>
54+
([Read more about SeleniumBase features](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/features_list.md))
5455

56+
<img src="https://cdn2.hubspot.net/hubfs/100006/images/SB_Logo8g.png" title="SeleniumBase" height="36">
5557

56-
### ![http://seleniumbase.com](https://cdn2.hubspot.net/hubfs/100006/images/super_logo_tiny.png "SeleniumBase") **Get Started with SeleniumBase**:
58+
## ![http://seleniumbase.com](https://cdn2.hubspot.net/hubfs/100006/images/super_logo_tiny.png "SeleniumBase") **Get Started**:
5759

5860
(Before installation, you'll need to **[install Python](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/before_installation.md)** and **[download a web driver]()**.)
5961

6062

61-
### **Step 1:** Clone SeleniumBase
63+
### ![http://seleniumbase.com](https://cdn2.hubspot.net/hubfs/100006/images/super_logo_tiny.png "SeleniumBase") **Step 1:** Clone SeleniumBase
6264

6365
```bash
6466
git clone https://github.com/seleniumbase/SeleniumBase.git
@@ -69,12 +71,12 @@ cd SeleniumBase
6971
(<i>A [Git](https://git-scm.com/) GUI tool like [SourceTree](http://www.sourcetreeapp.com/) may help.</i>)
7072

7173

72-
### **Step 2:** Create a Python Virtual Environment (optional)
74+
### ![http://seleniumbase.com](https://cdn2.hubspot.net/hubfs/100006/images/super_logo_tiny.png "SeleniumBase") **Step 2:** Create a Virtual Env
7375

74-
To learn how to create one, [see the ReadMe](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/virtualenv_instructions.md).<br><br><i>[python-guide.org/en/latest/dev/virtualenvs](http://docs.python-guide.org/en/latest/dev/virtualenvs/) has more details.</i>
76+
To learn how to create a Python virtual environment (OPTIONAL), [see the ReadMe](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/virtualenv_instructions.md).<br><br><i>[python-guide.org/en/latest/dev/virtualenvs](http://docs.python-guide.org/en/latest/dev/virtualenvs/) has more details.</i>
7577

7678

77-
### **Step 3:** Install SeleniumBase
79+
### ![http://seleniumbase.com](https://cdn2.hubspot.net/hubfs/100006/images/super_logo_tiny.png "SeleniumBase") **Step 3:** Install SeleniumBase
7880

7981
To install a clone of SeleniumBase, use:
8082
```bash

0 commit comments

Comments
 (0)