Skip to content
This repository was archived by the owner on Mar 4, 2020. It is now read-only.

Commit 933a114

Browse files
agentFinlandOndraM
authored andcommitted
Clarified README (#557)
* Clarified README - simplified some word choice for those new to the project and non-primary English speakers - corrected grammar - removed unnecessary words (clutter) - corrected sentence fragments - corrected improper verb choices - added extra headers to clarify purpose of each set of steps - rearranged some sentences so the focus of the sentence came earlier and/or became the subject
1 parent c95385a commit 933a114

File tree

1 file changed

+25
-22
lines changed

1 file changed

+25
-22
lines changed

README.md

Lines changed: 25 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ by the Selenium server and will also implement the [W3C WebDriver](https://w3c.g
1616
The concepts of this library are very similar to the "official" Java, .NET, Python and Ruby bindings from the
1717
[Selenium project](https://github.com/SeleniumHQ/selenium/).
1818

19-
**This is new version of PHP client, rewritten from scratch starting 2013.**
19+
**As of 2013, this PHP client has been rewritten from scratch.**
2020
Using the old version? Check out [Adam Goucher's fork](https://github.com/Element-34/php-webdriver) of it.
2121

2222
Looking for API documentation of php-webdriver? See [https://facebook.github.io/php-webdriver/](https://facebook.github.io/php-webdriver/latest/)
2323

24-
Any complaint, question, idea? You can post it on the user group https://www.facebook.com/groups/phpwebdriver/.
24+
Any complaints, questions, or ideas? Post them in the user group https://www.facebook.com/groups/phpwebdriver/.
2525

2626
## Installation
2727

@@ -37,15 +37,19 @@ Then install the library:
3737

3838
## Getting started
3939

40-
All you need as the server for this client is the `selenium-server-standalone-#.jar` file provided here: http://selenium-release.storage.googleapis.com/index.html
40+
### Start Server
4141

42-
Download and run that file, replacing # with the current server version. Keep in mind you must have Java 8+ installed to start this command.
42+
The required server is the `selenium-server-standalone-#.jar` file provided here: http://selenium-release.storage.googleapis.com/index.html
43+
44+
Download and run the server by replacing # with the current server version. Keep in mind **you must have Java 8+ installed to run this command**.
4345

4446
java -jar selenium-server-standalone-#.jar
4547

46-
(Please see note below when using Firefox.)
48+
**NOTE:** If using Firefox, see alternate command below.
49+
50+
### Create a Browser Session
4751

48-
Then when you create a session, be sure to pass the url to where your server is running.
52+
When creating a browser session, be sure to pass the url of your running server.
4953

5054
```php
5155
// This would be the url of the host running the server-standalone.jar
@@ -54,7 +58,7 @@ $host = 'http://localhost:4444/wd/hub'; // this is the default
5458

5559
##### Launch Chrome
5660

57-
Make sure to have latest Chrome and [Chromedriver](https://sites.google.com/a/chromium.org/chromedriver/downloads) installed.
61+
Make sure to have latest Chrome and [Chromedriver](https://sites.google.com/a/chromium.org/chromedriver/downloads) versions installed.
5862

5963
```php
6064
$driver = RemoteWebDriver::create($host, DesiredCapabilities::chrome());
@@ -64,8 +68,8 @@ $driver = RemoteWebDriver::create($host, DesiredCapabilities::chrome());
6468

6569
Make sure to have latest Firefox and [Geckodriver](https://github.com/mozilla/geckodriver/releases) installed.
6670

67-
Because Firefox (and Geckodriver) only supports new W3C WebDriver protocol (which is yet to be implemented by php-wedbriver - see [issue #469](https://github.com/facebook/php-webdriver/issues/469)),
68-
the protocols must be translated by Selenium server - this feature is *partially* available in Selenium server version 3.5.0-3.8.1 and you can enable it like this:
71+
Because Firefox (and Geckodriver) only support the new W3C WebDriver protocol (which is yet to be implemented by php-webdriver - see [issue #469](https://github.com/facebook/php-webdriver/issues/469)),
72+
the protocols must be translated by Selenium Server - this feature is *partially* available in Selenium Server versions 3.5.0-3.8.1 and you can enable it like this:
6973

7074
java -jar selenium-server-standalone-3.8.1.jar -enablePassThrough false
7175

@@ -75,7 +79,7 @@ Now you can start Firefox from your code:
7579
$driver = RemoteWebDriver::create($host, DesiredCapabilities::firefox());
7680
```
7781

78-
##### You can also customize the desired capabilities
82+
### Customize Desired Capabilities
7983

8084
```php
8185
$desired_capabilities = DesiredCapabilities::firefox();
@@ -85,7 +89,7 @@ $driver = RemoteWebDriver::create($host, $desired_capabilities);
8589

8690
* See https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities for more details.
8791

88-
* Above snippets are not intended to be a working example by simply copy pasting. See [example.php](example.php) for working example.
92+
**NOTE:** Above snippets are not intended to be a working example by simply copy-pasting. See [example.php](example.php) for working example.
8993

9094
## Changelog
9195
For latest changes see [CHANGELOG.md](CHANGELOG.md) file.
@@ -98,22 +102,21 @@ You may also want to check out the Selenium [docs](http://docs.seleniumhq.org/do
98102

99103
## Testing framework integration
100104

101-
To take advantage of automatized testing you will most probably want to integrate php-webdriver to your testing framework.
102-
There are some project already providing this:
105+
To take advantage of automatized testing you may want to integrate php-webdriver to your testing framework.
106+
There are some projects already providing this:
103107

104-
- [Steward](https://github.com/lmc-eu/steward) integrates php-webdriver directly to [PHPUnit](https://phpunit.de/), also providers parallelization.
105-
- [Codeception](http://codeception.com) testing framework provides BDD-layer on top of php-webdriver in its [WebDriver module](http://codeception.com/docs/modules/WebDriver).
106-
- You can also check out this [blogpost](http://codeception.com/11-12-2013/working-with-phpunit-and-selenium-webdriver.html) + [demo project](https://github.com/DavertMik/php-webdriver-demo), describing simple [PHPUnit](https://phpunit.de/) integration.
108+
- [Steward](https://github.com/lmc-eu/steward) integrates php-webdriver directly to [PHPUnit](https://phpunit.de/), and provides parallelization
109+
- [Codeception](http://codeception.com) testing framework provides BDD-layer on top of php-webdriver in its [WebDriver module](http://codeception.com/docs/modules/WebDriver)
110+
- You can also check out this [blogpost](http://codeception.com/11-12-2013/working-with-phpunit-and-selenium-webdriver.html) + [demo project](https://github.com/DavertMik/php-webdriver-demo), describing simple [PHPUnit](https://phpunit.de/) integration
107111

108112
## Support
109113

110-
We have a great community willing to try and help you!
114+
We have a great community willing to help you!
111115

112-
- **Via our Facebook Group** - If you have questions or are an active contributor consider joining our [facebook group](https://www.facebook.com/groups/phpwebdriver/) and contributing to the communal discussion and support.
113-
- **Via StackOverflow** - You can also [ask a question](https://stackoverflow.com/questions/ask?tags=php+selenium-webdriver) or find many already answered question on StackOverflow.
114-
- **Via GitHub** - Another option if you have a question (or bug report) is to [submit it here](https://github.com/facebook/php-webdriver/issues/new) as an new issue.
116+
- **Via our Facebook Group** - If you have questions or are an active contributor consider joining our [facebook group](https://www.facebook.com/groups/phpwebdriver/) and contribute to communal discussion and support
117+
- **Via StackOverflow** - You can also [ask a question](https://stackoverflow.com/questions/ask?tags=php+selenium-webdriver) or find many already answered question on StackOverflow
118+
- **Via GitHub** - Another option if you have a question (or bug report) is to [submit it here](https://github.com/facebook/php-webdriver/issues/new) as an new issue
115119

116120
## Contributing
117121

118-
We love to have your help to make php-webdriver better. See [CONTRIBUTING.md](CONTRIBUTING.md) for more information
119-
about contributing and developing php-webdriver.
122+
We love to have your help to make php-webdriver better. See [CONTRIBUTING.md](CONTRIBUTING.md) for more information about contributing and developing php-webdriver.

0 commit comments

Comments
 (0)