Merge pull request php-webdriver#277 from OndraM/changelog

Add a changelog, cleanup readme

Author: gfosco

CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+This project versioning adheres to [Semantic Versioning](http://semver.org/).
+
+## Unreleased
+- Added CHANGELOG.md
+
+## 1.1.1 - 2015-12-31
+- Fixed strict standards error in `ChromeDriver`
+- Added unit tests for `WebDriverCommand` and `DesiredCapabilities`
+- Fixed retrieving temporary path name in `FirefoxDriver` when `open_basedir` restriction is in effect 
+
+## 1.1.0 - 2015-12-08
+- FirefoxProfile improved - added possibility to set RDF file and to add datas for extensions
+- Fixed setting 0 second timeout of `WebDriverWait`

README.md

@@ -1,99 +1,80 @@
-php-webdriver -- WebDriver bindings for PHP
+php-webdriver – WebDriver bindings for PHP
 ===========================================
 
-##  DESCRIPTION
+## Description
+Php-webdriver library is PHP language binding for Selenium WebDriver, which allows you to control web browsers from PHP.
 
-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.
+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.
 
-Looking for documentation about php-webdriver? See http://facebook.github.io/php-webdriver/
+This is new version of PHP client, rewritten from scratch starting 2013.
+Using the old version? Check out Adam Goucher's fork of it at https://github.com/Element-34/php-webdriver
 
-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
+Looking for API documentation of php-webdriver? See http://facebook.github.io/php-webdriver/
 
 Any complaint, question, idea? You can post it on the user group https://www.facebook.com/groups/phpwebdriver/.
 
-##  GETTING THE CODE
+## Installation
 
-There are two ways of getting the code:
+Installation is possible using [Composer](https://getcomposer.org/).
 
-### Via Github
-    git clone [email protected]:facebook/php-webdriver.git
-
-### Via Packagist
-Add the dependency to composer.json (see https://packagist.org/packages/facebook/webdriver)
-
-```json
-{
-  "require": {
-    "facebook/webdriver": "~1.0"
-  }
-}
-```
-
-## INSTALLATION
-
-Download the composer.phar
+If you don't already use Composer, you can download the `composer.phar` binary:
 
     curl -sS https://getcomposer.org/installer | php
 
-Install the library.
+Then install the library:
 
-    php composer.phar install
+    php composer.phar require facebook/webdriver
 
+## Getting started
 
-##  GETTING STARTED
+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
 
-*   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
-
-*   Download and run that file, replacing # with the current server version.
+* Download and run that file, replacing # with the current server version.
 
     ```
     java -jar selenium-server-standalone-#.jar
     ```
 
-*   Then when you create a session, be sure to pass the url to where your server is running.
+Then when you create a session, be sure to pass the url to where your server is running.
 
     ```php
     // This would be the url of the host running the server-standalone.jar
     $host = 'http://localhost:4444/wd/hub'; // this is the default
     ```
 
-*   Launch Firefox
+* Launch Firefox:
 
     ```php
     $driver = RemoteWebDriver::create($host, DesiredCapabilities::firefox());
     ```
 
-*   Launch Chrome
+* Launch Chrome:
 
     ```php
     $driver = RemoteWebDriver::create($host, DesiredCapabilities::chrome());
     ```
 
-*   You can also customize the desired capabilities.
+You can also customize the desired capabilities:
 
     ```php
     $desired_capabilities = DesiredCapabilities::firefox();
-    $desired_capabilities->setJavascriptEnabled(false);
-    RemoteWebDriver::create($host, $desired_capabilities);
+    $desired_capabilities->setCapability('acceptSslCerts', false);
+    $driver = RemoteWebDriver::create($host, $desired_capabilities);
     ```
 
-*   See https://code.google.com/p/selenium/wiki/DesiredCapabilities for more details.
+* See https://code.google.com/p/selenium/wiki/DesiredCapabilities for more details.
 
-## RUN UNIT TESTS
+## Changelog
+For latest changes see [CHANGELOG.md](CHANGELOG.md) file.
 
-To run unit tests simply run:
-
-    ./vendor/bin/phpunit -c ./tests
-
-Note: For the functional test suite, a running selenium server is required.
-
-## MORE INFORMATION
+## More information
 
 Check out the Selenium docs and wiki at http://docs.seleniumhq.org/docs/ and https://code.google.com/p/selenium/wiki
 
 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)
 
-## SUPPORT
+## Support
 
 We have a great community willing to try and help you!
 
@@ -109,12 +90,20 @@ https://www.facebook.com/groups/phpwebdriver/
 
 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.
 
-## CONTRIBUTING
+## Contributing
 
-We love to have your help to make php-webdriver better. Feel free to 
+We love to have your help to make php-webdriver better. Feel free to
 
-*   open an [issue](https://github.com/facebook/php-webdriver/issues) if you run into any problem. 
-*   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. 
+* open an [issue](https://github.com/facebook/php-webdriver/issues) if you run into any problem.
+* 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.
 
 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#.
 FYI, here is the overview of [the official Java API](http://selenium.googlecode.com/svn/trunk/docs/api/java/index.html?overview-summary.html)
+
+### Run unit tests
+
+To run unit tests simply run:
+
+    ./vendor/bin/phpunit -c ./tests
+
+Note: For the functional test suite, a running selenium server is required.