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

Commit f89848d

Browse files
committed
Cleanup README a bit
1 parent a7fd742 commit f89848d

File tree

1 file changed

+26
-40
lines changed

1 file changed

+26
-40
lines changed

README.md

Lines changed: 26 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,61 @@
1-
php-webdriver -- WebDriver bindings for PHP
1+
php-webdriver WebDriver bindings for PHP
22
===========================================
33

4-
## DESCRIPTION
4+
## Description
5+
Php-webdriver library is PHP language binding for Selenium WebDriver, which allows you to control web browsers from PHP.
56

6-
This WebDriver client aims to be as close as possible to bindings in other languages. The concepts are very similar to the Java, .NET, Python and Ruby bindings for WebDriver.
7+
This WebDriver client aims to be as close as possible to bindings in other languages.
8+
The concepts are very similar to the Java, .NET, Python and Ruby bindings for WebDriver.
79

8-
Looking for documentation about php-webdriver? See http://facebook.github.io/php-webdriver/
10+
This is new version of PHP client, rewritten from scratch starting 2013.
11+
Using the old version? Check out Adam Goucher's fork of it at https://github.com/Element-34/php-webdriver
912

10-
The PHP client was rewritten from scratch. Using the old version? Check out Adam Goucher's fork of it at https://github.com/Element-34/php-webdriver
13+
Looking for API documentation of php-webdriver? See http://facebook.github.io/php-webdriver/
1114

1215
Any complaint, question, idea? You can post it on the user group https://www.facebook.com/groups/phpwebdriver/.
1316

14-
## GETTING THE CODE
17+
## Installation
1518

16-
There are two ways of getting the code:
19+
Installation is possible using [Composer](https://getcomposer.org/).
1720

18-
### Via Github
19-
git clone git@github.com:facebook/php-webdriver.git
20-
21-
### Via Packagist
22-
Add the dependency to composer.json (see https://packagist.org/packages/facebook/webdriver)
23-
24-
```json
25-
{
26-
"require": {
27-
"facebook/webdriver": "~1.0"
28-
}
29-
}
30-
```
31-
32-
## INSTALLATION
33-
34-
Download the composer.phar
21+
If you don't already use Composer, you can download the `composer.phar` binary:
3522

3623
curl -sS https://getcomposer.org/installer | php
3724

38-
Install the library.
39-
40-
php composer.phar install
25+
Then install the library:
4126

27+
php composer.phar require facebook/webdriver
4228

43-
## GETTING STARTED
29+
## Getting started
4430

45-
* 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
31+
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
4632

47-
* Download and run that file, replacing # with the current server version.
33+
* Download and run that file, replacing # with the current server version.
4834

4935
```
5036
java -jar selenium-server-standalone-#.jar
5137
```
5238
53-
* Then when you create a session, be sure to pass the url to where your server is running.
39+
Then when you create a session, be sure to pass the url to where your server is running.
5440
5541
```php
5642
// This would be the url of the host running the server-standalone.jar
5743
$host = 'http://localhost:4444/wd/hub'; // this is the default
5844
```
5945
60-
* Launch Firefox
46+
* Launch Firefox:
6147
6248
```php
6349
$driver = RemoteWebDriver::create($host, DesiredCapabilities::firefox());
6450
```
6551
66-
* Launch Chrome
52+
* Launch Chrome:
6753
6854
```php
6955
$driver = RemoteWebDriver::create($host, DesiredCapabilities::chrome());
7056
```
7157
72-
* You can also customize the desired capabilities.
58+
You can also customize the desired capabilities:
7359
7460
```php
7561
$desired_capabilities = DesiredCapabilities::firefox();
@@ -82,13 +68,13 @@ Install the library.
8268
## Changelog
8369
For latest changes see [CHANGELOG.md](CHANGELOG.md) file.
8470
85-
## MORE INFORMATION
71+
## More information
8672
8773
Check out the Selenium docs and wiki at http://docs.seleniumhq.org/docs/ and https://code.google.com/p/selenium/wiki
8874
8975
Learn how to integrate it with PHPUnit [Blogpost](http://codeception.com/11-12-2013/working-with-phpunit-and-selenium-webdriver.html) | [Demo Project](https://github.com/DavertMik/php-webdriver-demo)
9076
91-
## SUPPORT
77+
## Support
9278
9379
We have a great community willing to try and help you!
9480
@@ -104,12 +90,12 @@ https://www.facebook.com/groups/phpwebdriver/
10490
10591
If you're reading this you've already found our Github repository. If you have a question, feel free to submit it as an issue and our staff will do their best to help you as soon as possible.
10692
107-
## CONTRIBUTING
93+
## Contributing
10894
109-
We love to have your help to make php-webdriver better. Feel free to
95+
We love to have your help to make php-webdriver better. Feel free to
11096
111-
* open an [issue](https://github.com/facebook/php-webdriver/issues) if you run into any problem.
112-
* fork the project and submit [pull request](https://github.com/facebook/php-webdriver/pulls). Before the pull requests can be accepted, a [Contributors Licensing Agreement](http://developers.facebook.com/opensource/cla) must be signed.
97+
* open an [issue](https://github.com/facebook/php-webdriver/issues) if you run into any problem.
98+
* fork the project and submit [pull request](https://github.com/facebook/php-webdriver/pulls). Before the pull requests can be accepted, a [Contributors Licensing Agreement](http://developers.facebook.com/opensource/cla) must be signed.
11399
114100
When you are going to contribute, please keep in mind that this webdriver client aims to be as close as possible to other languages Java/Ruby/Python/C#.
115101
FYI, here is the overview of [the official Java API](http://selenium.googlecode.com/svn/trunk/docs/api/java/index.html?overview-summary.html)

0 commit comments

Comments
 (0)