Version 1

[yaffs-website] / vendor / jcalderonzumba / mink-phantomjs-driver / README.md

diff --git a/vendor/jcalderonzumba/mink-phantomjs-driver/README.md b/vendor/jcalderonzumba/mink-phantomjs-driver/README.md
new file mode 100644 (file)
index 0000000..e9d3236
--- /dev/null
+++ b/vendor/jcalderonzumba/mink-phantomjs-driver/README.md
@@ -0,0 +1,65 @@
+Mink PhantomJS Driver
+===========================
+[![Build Status](https://travis-ci.org/jcalderonzumba/MinkPhantomJSDriver.svg?branch=master)](https://travis-ci.org/jcalderonzumba/MinkPhantomJSDriver)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/jcalderonzumba/MinkPhantomJSDriver/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/jcalderonzumba/MinkPhantomJSDriver/?branch=master)
+[![Latest Stable Version](https://poser.pugx.org/jcalderonzumba/mink-phantomjs-driver/v/stable)](https://packagist.org/packages/jcalderonzumba/mink-phantomjs-driver)
+[![Total Downloads](https://poser.pugx.org/jcalderonzumba/mink-phantomjs-driver/downloads)](https://packagist.org/packages/jcalderonzumba/mink-phantomjs-driver)
+
+Installation & Compatibility
+----------------------------
+You need a working installation of [PhantomJS](http://phantomjs.org/download.html)
+
+This driver is tested using PhantomJS 1.9.8 but it should work with 1.9.X or latest 2.0.X versions
+
+This driver supports **PHP 5.4 or greater**, there is NO support for PHP 5.3
+
+Use [Composer](https://getcomposer.org/) to install all required PHP dependencies:
+
+```bash
+$ composer require --dev behat/mink jcalderonzumba/mink-phantomjs-driver
+```
+
+How to use
+-------------
+Extension configuration (for the moment NONE).
+```yml
+default:
+  extensions:
+    Zumba\PhantomJSExtension:
+```
+Driver specific configuration:
+```yml
+Behat\MinkExtension:
+phantomjs:
+    phantom_server: "http://localhost:8510/api"
+    template_cache: "/tmp/pjsdrivercache/phantomjs"
+```
+PhantomJS browser start:
+```bash
+phantomjs --ssl-protocol=any --ignore-ssl-errors=true vendor/jcalderonzumba/gastonjs/src/Client/main.js 8510 1024 768 2>&1 >> /tmp/gastonjs.log &
+```
+Driver instantiation:
+```php
+$driver = new Zumba\Mink\Driver\PhantomJSDriver('http://localhost:8510');
+```
+
+FAQ
+---------
+
+1. Is this a selenium based driver?:
+
+  **NO**, it has nothing to do with Selenium it's inspired on [Poltergeist](https://github.com/teampoltergeist/poltergeist)
+
+2. What features does this driver implements?
+  
+  **ALL** of the features defined in Mink DriverInterface. maximizeWindow is the only one not implemented since is a headless browser it does not make sense to implement it.
+
+3. Do i need to modify my selenium based tests?
+
+  If you only use the standard behat driver defined methods then NO, you just have to change your default javascript driver.
+  
+
+Copyright
+---------
+
+Copyright (c) 2015 Juan Francisco Calderon Zumba <juanfcz@gmail.com>