Merge pull request #31 from stof/browserkit

Add the documentation about the BrowserKitDriver

Author: stof

drivers/browserkit.rst

@@ -0,0 +1,40 @@
+BrowserKitDriver
+================
+
+BrowserKitDriver provides a bridge for the `Symfony BrowserKit`_ component.
+BrowserKit is a browser emulator provided by the `Symfony project`_.
+
+Installation
+------------
+
+BrowserKitDriver is a pure PHP library available through Composer:
+
+.. code-block:: bash
+
+    $ composer require behat/mink-browserkit-driver
+
+.. note::
+
+    The BrowserKit component only provides an abstract implementation. The
+    actual implementation are provided by other projects, like `Goutte`_
+    or the `Symfony HttpKernel`_ component.
+
+    If you are using Goutte, you should use the special :doc:`/drivers/goutte`
+    which ensures full compatibility for Goutte due to an edge case in Goutte.
+
+Usage
+-----
+
+In order to talk with BrowserKit, you should instantiate a
+``Behat\Mink\Driver\BrowserKitDriver``:
+
+.. code-block:: php
+
+    $browserkitClient = // ...
+
+    $driver = new \Behat\Mink\Driver\BrowserKitDriver($browserkitClient);
+
+.. _Goutte: https://github.com/FriendsOfPHP/Goutte
+.. _Symfony BrowserKit: http://symfony.com/components/BrowserKit
+.. _Symfony HttpKernel: http://symfony.com/components/HttpKernel
+.. _Symfony project: http://symfony.com

drivers/goutte.rst

@@ -5,6 +5,12 @@ GoutteDriver provides a bridge for the `Goutte`_ headless browser. Goutte
 is a classical pure-php headless browser, written by the creator of the Symfony
 framework Fabien Potencier.
 
+.. note::
+
+    The GoutteDriver extends the :doc:`/drivers/browserkit` to fix a small
+    edge case in the Goutte implementation of BrowserKit. It is also able
+    to instantiate the Goutte client automatically.
+
 Installation
 ------------
 

guides/drivers.rst

@@ -9,12 +9,13 @@ Mink always talks with browser emulators through its driver. It doesn't know
 anything about how to start/stop or traverse page in that particular browser
 emulator. It only knows what driver method it should call in order to do this.
 
-Mink comes with five drivers out of the box:
+Mink comes with six drivers out of the box:
 
 .. toctree::
     :maxdepth: 1
 
     /drivers/goutte
+    /drivers/browserkit
     /drivers/selenium2
     /drivers/zombie
     /drivers/sahi