Removing markdown folder

markdown/index.md

@@ -1,120 +0,0 @@
-Introduction
-============
-
-PHP PhantomJS is a flexible PHP library to load pages through the PhantomJS headless browser and return the page response. It is handy for testing websites that demand javascript support and also supports screen captures.
-
-Feature List
-------------
-
-*  Load webpages through the PhantomJS headless browser
-*  View detailed response data including page content, headers, status
-   code etc.
-*  Handle redirects
-*  View javascript console errors
-*  View detailed PhantomJS debuged information
-*  Save screen captures to local disk
-*  Define screen capture x, y, width and height parameters
-*  Delay page rendering for a specified time
-*  Execute PhantomJS with command line options
-*  Easily build and run custom PhantomJS scripts
-
-Prerequisites
--------------
-
-PHP PhantomJS requires PHP **5.3.0** or greater to run.
-
-Installation
-------------
-
-It is recommended that you use Composer to install PHP PhantomJS. First, add the following to your project’s `composer.json` file:
-
-```yaml
-
-    "scripts": {
-        "post-install-cmd": [
-            "PhantomInstaller\\Installer::installPhantomJS"
-        ],
-        "post-update-cmd": [
-            "PhantomInstaller\\Installer::installPhantomJS"
-        ]
-    }
-```
-
-This will ensure the latest version of PhantomJS is installed for your system, in your bin folder. If you haven’t defined your bin folder in your composer.json, add the path:
-
-```yaml
-
-    "config": {
-        "bin-dir": "bin"
-    }
-```
-
-Finally, install PHP PhantomJS from the root of your project:
-
-```shell
-
-    composer require "jonnyw/php-phantomjs:3.*"
-```
-
-If you would like to use another installation method or would like to see more detailed installation instructions, see the [installation](http://jonnnnyw.github.io/php-phantomjs/installation.html) documentation.
-
-Basic Usage
------------
-
-The following illustrates how to make a basic GET request and output the page content:
-
-```php
-
-    <?php
-
-    use JonnyW\PhantomJs\Client;
-
-    $client = Client::getInstance();
-
-    /** 
-     * @see JonnyW\PhantomJs\Message\Request 
-     **/
-    $request = $client->getMessageFactory()->createRequest('http://google.com', 'GET');
-
-    /** 
-     * @see JonnyW\PhantomJs\Message\Response 
-     **/
-    $response = $client->getMessageFactory()->createResponse();
-
-    // Send the request
-    $client->send($request, $response);
-
-    if($response->getStatus() === 200) {
-
-        // Dump the requested page content
-        echo $response->getContent();
-    }
-```
-
-And if you would like to save a screen capture to local disk:
-
-```php
-
-    <?php
-
-    use JonnyW\PhantomJs\Client;
-
-    $client = Client::getInstance();
-
-    /** 
-     * @see JonnyW\PhantomJs\Message\CaptureRequest
-     **/
-    $request = $client->getMessageFactory()->createCaptureRequest('http://google.com', 'GET');
-    $request->setCaptureFile('/path/to/save/capture/file.jpg');
-
-    /** 
-     * @see JonnyW\PhantomJs\Message\Response 
-     **/
-    $response = $client->getMessageFactory()->createResponse();
-
-    // Send the request
-    $client->send($request, $response);
-```
-
-For more detailed examples see the [examples](http://jonnnnyw.github.io/php-phantomjs/examples.html) section, or to create your own custom scripts check out the [advanced](http://jonnnnyw.github.io/php-phantomjs/advanced.html) documentation.
-

markdown/installation.md

@@ -1,108 +0,0 @@
-Installation
-============
-
-Prerequisites
--------------
-
-PHP PhantomJS requires PHP **5.3.0** or greater to run.
-
-Installing via Composer
------------------------
-
-Install [Composer](https://getcomposer.org/) for your project:
-
-``shell
-
-        curl -s http://getcomposer.org/installer | php
-``
-
-Create a `composer.json` file in the root of your project:
-
-```yaml
-
-        {
-            "require": {
-                "jonnyw/php-phantomjs": "3.*"
-            },
-            "config": {
-                "bin-dir": "bin"
-            },
-            "scripts": {
-                "post-install-cmd": [
-                    "PhantomInstaller\\Installer::installPhantomJS"
-                ],
-                "post-update-cmd": [
-                    "PhantomInstaller\\Installer::installPhantomJS"
-                ]
-            }
-        }
-```
-
-It is important that you have the 'scripts' section shown above in your `composer.json` file as it will install the latest version of PhantomJS for your system to your project's bin folder. It is recommended that you create a bin folder in the root of your project as this is where the PHP PhantomJS library will look for your PhantomJS executable. If you would prefer to use a PhantomJS executable in a custom location, see the [Custom Installation](#custom-installation) section.
-
-Finally, install the composer depedencies for your project:
-
-```shell
-
-        php composer.phar install
-```
-
-Custom Installation
--------------------
-
-If you would prefer to use a custom install location for the PhantomJS executable, you simply need to tell the client where to find the executable file:
-
-```php
-
-        use JonnyW\PhantomJs\Client;
-
-        $client = Client::getInstance();
-        $client->setPhantomJs('/path/to/phantomjs');
-```
-
-If you would like composer to install the PhantomJS executable to a custom location when installing dependencies, set the bin dir location in your project's `composer.json` file:
-
-```yaml
-
-        {
-            "config": {
-                "bin-dir": "/path/to/your/projects/bin/dir"
-            }
-        }
-```
-
-You will need to make sure that this directory exists and is writable by Composer before running the composer install.
-
-Once you have updated your bin location run composer install to install PhantomJS:
-
-```shell
-
-        php composer.phar install
-```
-
-This should install the correct PhantomJS executable for your system to the bin locaiton you defined in your `composer.json` file. As mentioned above, you will need to tell the client where to find your PhantomJS executable as it is not installed in the default location:
-
-```php
-
-        use JonnyW\PhantomJs\Client;
-
-        $client = Client::getInstance();
-        $client->setPhantomJs('/path/to/phantomjs');
-```
-
-Installing from tarball
------------------------
-
-The PHP PhantomJS library contains several depedencies in order to function so it is recommended that you install it via composer as this will handle your dependencies for you. If you do wish to install it from a [tarball release](https://github.com/jonnnnyw/php-phantomjs/tags) then you will need to install the dependencies manually.
-
-The PHP PhantomJS library currently requires the following depdencies:
-
--  [Symfony Config Component](https://github.com/symfony/Config) ~2.5
--  [Symfony Dependency Injection Component](https://github.com/symfony/DependencyInjection) ~2.5
--  [Symfony Filesystem Component](https://github.com/symfony/filesystem) ~2.5
--  [Twig templating Component](https://github.com/fabpot/Twig) ~1.16
--  [PhantomJS](http://phantomjs.org/) ~1.9
-
-Make sure the components are in your include path and that the PhantomJS
-executable is installed to your projects bin folder as mentioned in the
-[Custom Installation](#custom-installation) section.

markdown/usage.md

@@ -1,264 +0,0 @@
-Usage
-========
-
-This page contains some common examples of how to use the PHP PhantomJS library.
-
-* [Basic Request](#basic-request)
-* [POST Request](#post-request)
-* [Other Request Methods](#other-request-methods)
-* [Response Data](#response-data)
-* [Screen Captures](#screen-captures)
-* [Custom Timeout](#custom-timeout)
-* [Delay Page Render](#delay-page-render)
-* [Custom Run Options](#custom-run-options)
-
-Basic Request
--------------
-
-A basic GET request:
-
-```php
-
-    use JonnyW\PhantomJs\Client;
-    
-    $client = Client::getInstance();
-    
-    $request  = $client->getMessageFactory()->createRequest();
-    $response = $client->getMessageFactory()->createResponse();
-    
-    $request->setMethod('GET');
-    $request->setUrl('http://google.com');
-    
-    $client->send($request, $response);
-    
-    if($response->getStatus() === 200) {
-        echo $response->getContent();
-    }
-```
-
-You can also set the URL, request method and timeout period when creating a new request instance through the message factory:
-
-```php
-
-    use JonnyW\PhantomJs\Client;
-    
-    $client = Client::getInstance();
-    
-    $request  = $client->getMessageFactory()->createRequest('http://google.com', 'GET', 5000);
-    $response = $client->getMessageFactory()->createResponse();
-        
-    $client->send($request, $response);
-    
-    if($response->getStatus() === 200) {
-        echo $response->getContent();
-    }
-```
-
-POST Request
-------------
-
-A basic POST request:
-
-```php
-
-    use JonnyW\PhantomJs\Client;
-    
-    $client = Client::getInstance();
-    
-    $request  = $client->getMessageFactory()->createRequest();
-    $response = $client->getMessageFactory()->createResponse();
-    
-    $data = array(
-        'param1' => 'Param 1',
-        'param2' => 'Param 2'
-    );
-    
-    $request->setMethod('POST');
-    $request->setUrl('http://google.com');
-    $request->setRequestData($data); // Set post data
-    
-    $client->send($request, $response);
-```
-
-Other Request Methods
----------------------
-
-The PHP PhantomJS library supports the following request methods:
-
-* OPTIONS
-* GET
-* HEAD
-* POST
-* PUT
-* DELETE
-* PATCH
-
-The request method can be set when creating a new request instance through the message factory:
-
-```php
-
-    use JonnyW\PhantomJs\Client;
-    
-    $client = Client::getInstance();
-    
-    $request  = $client->getMessageFactory()->createRequest('http://google.com', 'PUT');
-```
-
-Or on the request instance itself:
-
-```php
-
-    use JonnyW\PhantomJs\Client;
-    
-    $client = Client::getInstance();
-    
-    $request  = $client->getMessageFactory()->createRequest();
-    $request->setMethod('PATCH');
-```
-
-Response Data
--------------
-
-A standard response gives you access to the following interface:
-
-| Accessor            | Description                                                                               |  Return Type   |
-| :-----------------: | ----------------------------------------------------------------------------------------- | :------------: |
-| getHeaders()        | Returns an array of all response headers.                                                 | Array          |
-| getHeader(*header*) | Returns the value for a specific response header e.g. Content-Type.                       | Mixed          |
-| getStatus()         | The response status code e.g. 200.                                                        | Int            |
-| getContent()        | The raw page content of the requested page.                                               | String         |
-| getContentType()    | The content type of the requested page.                                                   | String         |
-| getUrl()            | The URL of the requested page.                                                            | String         |
-| getRedirectUrl()    | If the response was a redirect, this will return the redirect URL.                        | String         |
-| isRedirect()        | Will return true if the response was a redirect or false otherwise.                       | Boolean        |
-| getConsole()        | Returns an array of any javascript errors on the requested page along with a stack trace. | Array          |
-
-If the response contains a status code of 0, chances are the request failed. Check the request [debug log](https://github.com/jonnnnyw/php-phantomjs/blob/master/doc/debugging.rst) for more detailed information about what may have gone wrong.
-
-Screen Captures
----------------
-
-You can save screen captures of a page to your local disk by creating a screen capture request and setting the path you wish to save the file to:
-
-```php
-
-    use JonnyW\PhantomJs\Client;
-    
-    $client = Client::getInstance();
-    
-    $request  = $client->getMessageFactory()->createCaptureRequest('http://google.com');
-    $response = $client->getMessageFactory()->createResponse();
-    
-    $file = '/path/to/save/your/screen/capture/file.jpg';
-    
-    $request->setCaptureFile($file);
-    
-    $client->send($request, $response);
-```
-
-You will need to make sure the directory that you are saving the file to exists and is writable by your application.
-
-You can also set the width, height, x and y axis for your screen capture:
-
-```php
-
-    use JonnyW\PhantomJs\Client;
-    
-    $client = Client::getInstance();
-    
-    $request  = $client->getMessageFactory()->createCaptureRequest('http://google.com');
-    $response = $client->getMessageFactory()->createResponse();
-    
-    $file = '/path/to/save/your/screen/capture/file.jpg';
-    
-    $top    = 10;
-    $left   = 10;
-    $width  = 200;
-    $height = 400;
-    
-    $request->setCaptureFile($file);
-    $request->setCaptureDimensions($width, $height, $top, $left);
-    
-    $client->send($request, $response);
-```
-
-Custom Timeout
---------------
-
-By default, each request will timeout after 5 seconds. You can set a custom timeout period (in milliseconds) for each request:
-
-```php
-
-    use JonnyW\PhantomJs\Client;
-    
-    $client = Client::getInstance();
-    
-    $request  = $client->getMessageFactory()->createRequest('http://google.com');
-    $response = $client->getMessageFactory()->createResponse();
-    
-    $timeout = 10000; // 10 seconds
-    
-    $request->setTimeout($timeout);
-    
-    $client->send($request, $response);
-```
-
-Delay Page Render
------------------
-
-Sometimes when taking screen captures you may want to wait until the page is completely loaded before saving the capture. In this instance you can set a page render delay (in seconds) for the request:
-
-```php
-
-    use JonnyW\PhantomJs\Client;
-    
-    $client = Client::getInstance();
-    
-    $request  = $client->getMessageFactory()->createCaptureRequest('http://google.com');
-    $response = $client->getMessageFactory()->createResponse();
-    
-    $delay = 5; // 5 seconds
-    
-    $request->setDelay($delay);
-    
-    $client->send($request, $response);
-```
-
-You can set a page render delay for standard requests also.
-
-
-Custom Run Options
-------------------
-
-The PhantomJS API contains a range of command line options that can be passed when executing the PhantomJS executable. These can also be passed in via the client before a request:
-
-```php
-
-    use JonnyW\PhantomJs\Client;
-    
-    $client = Client::getInstance();
-    $client->addOption('--load-images=true');
-    $client->addOption('--ignore-ssl-errors=true');
-    
-    $request  = $client->getMessageFactory()->createRequest('http://google.com');
-    $response = $client->getMessageFactory()->createResponse();
-
-    $client->send($request, $response);
-```
-
-You can also set a path to a JSON configuration file that contains multiple PhantomJS options:
-
-```php
-
-    use JonnyW\PhantomJs\Client;
-    
-    $client = Client::getInstance();
-    $client->addOption('--config=/path/to/config.json');
-    
-    $request  = $client->getMessageFactory()->createRequest('http://google.com');
-    $response = $client->getMessageFactory()->createResponse();
-
-    $client->send($request, $response);
-```
-
-See the [PhantomJS Documentation](http://phantomjs.org/api/command-line.html) for a full list of command line options.