Skip to content

Commit 62570ec

Browse files
committed
Update ReadMe files
1 parent 2c29f32 commit 62570ec

File tree

2 files changed

+16
-21
lines changed

2 files changed

+16
-21
lines changed

README.md

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,17 @@
1-
[<img src="https://cdn2.hubspot.net/hubfs/100006/images/sb_logo_c.png" title="SeleniumBase" align="center" height="157">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
2-
3-
All-in-one framework for fast & simple browser automation and end-to-end testing.
1+
[<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_3.png" title="SeleniumBase" height="48">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
2+
[<img src="https://cdn2.hubspot.net/hubfs/100006/images/sb_logo_d.png" title="SeleniumBase" align="center" height="155">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
43

54
[<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)
65

7-
SeleniumBase uses [pytest](https://github.com/pytest-dev/pytest) for running tests, while using [Selenium WebDriver](https://www.seleniumhq.org/) for controlling web browsers.<br />
6+
Reliable Automation & Testing with [WebDriver APIs](https://www.seleniumhq.org/) & [pytest](https://docs.pytest.org/en/latest/).
87

9-
Run [my_first_test.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py) in Demo Mode to see test assertions:
10-
```bash
8+
<img src="https://cdn2.hubspot.net/hubfs/100006/sb_demo_mode.gif" title="SeleniumBase" height="236"><br />
9+
(<i>Above: [my_first_test.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py) from [examples/](https://github.com/seleniumbase/SeleniumBase/tree/master/examples) running in Demo Mode.</i>)<br />
10+
```
1111
pytest my_first_test.py --demo
1212
```
1313

14-
<img src="https://cdn2.hubspot.net/hubfs/100006/images/my_first_test_mov4.gif" title="SeleniumBase" />
15-
16-
<img src="https://cdn2.hubspot.net/hubfs/100006/images/my_first_test_7.png" title="SeleniumBase" />
17-
18-
SeleniumBase includes tools for automated [visual testing](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/visual_testing/ReadMe.md), assisted-QA with [MasterQA](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md), and creating [website tours](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md).
14+
SeleniumBase includes tools for [visual testing](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/visual_testing/ReadMe.md), [assisted validation](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md), and [user onboarding](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md).
1915

2016
## <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Get Started:
2117

@@ -43,11 +39,6 @@ pip install -r requirements.txt
4339
python setup.py install
4440
```
4541

46-
You can also install a specific GitHub branch of SeleniumBase:
47-
```bash
48-
pip install git+https://github.com/seleniumbase/SeleniumBase.git@master#egg=seleniumbase
49-
```
50-
5142
### <img src="https://cdn2.hubspot.net/hubfs/100006/images/super_square_logo_3a.png" title="SeleniumBase" height="32"> Download a webdriver:
5243

5344
SeleniumBase can download a webdriver to the [seleniumbase/drivers](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/drivers) folder with the ``install`` command:
@@ -693,4 +684,4 @@ If you see something, say something! We are very active in resolving issues. [<i
693684

694685
[https://github.com/mdmintz](https://github.com/mdmintz)<br />
695686

696-
[<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_5.png" title="SeleniumBase" height="45">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md) <br /> [<img src="https://img.shields.io/badge/license-MIT-22BBCC.svg" alt=" " />](https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE)
687+
[<img src="https://cdn2.hubspot.net/hubfs/100006/images/sb_media_logo_4.png" title="SeleniumBase" height="140">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md) <br /> [<img src="https://img.shields.io/badge/license-MIT-22BBCC.svg" alt=" " />](https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE)

help_docs/install.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,23 @@
22

33
If you're installing SeleniumBase from a cloned copy on your machine, use:
44
```
5-
pip install -U -r requirements.txt
5+
pip install -r requirements.txt
66
77
python setup.py install
88
```
99

1010
If you're installing SeleniumBase directly [from PyPI (the Python Package Index)](https://pypi.python.org/pypi/seleniumbase), use:
1111
```bash
12-
pip install -U seleniumbase
12+
pip install seleniumbase
1313
```
1414

15-
If you're installing SeleniumBase directly [from GitHub](https://github.com/seleniumbase/SeleniumBase), use:
15+
If you're installing SeleniumBase [from a GitHub branch](https://github.com/seleniumbase/SeleniumBase), use:
1616
```bash
17-
pip install -U -e git+https://github.com/seleniumbase/SeleniumBase.git@master#egg=seleniumbase
17+
pip install git+https://github.com/seleniumbase/SeleniumBase.git@master#egg=seleniumbase
1818
```
1919

20+
Useful ``pip`` options include:
21+
* Add ``--upgrade`` OR ``-U`` to upgrade an installation.
22+
* Add ``--force-reinstall`` for a clean install.
23+
2024
(If you're not using a virtual environment, you may need to add ``--user`` to your ``pip`` command if you're getting errors during installation.)

0 commit comments

Comments
 (0)