installation.md

Installation

To install the Wid'op Twitter library, you will need Composer. It's a PHP 5.3+ dependency manager which allows you to declare the dependent libraries your project needs and it will install & autoload them for you.

Set up Composer

Composer comes with a simple phar file. To easily access it from anywhere on your system, you can execute:

$ curl -s https://getcomposer.org/installer | php
$ sudo mv composer.phar /usr/local/bin/composer

Define dependencies

Create a composer.json file at the root directory of your project and simply require the widop/twitter-rest package:

{
    "require": {
        "widop/twitter-rest": "~1.0@dev"
    },
    "minimum-stability": "dev",
    "prefer-stable": true
}

For now, you need to set the minimum-stability option to dev and the prefer-stable flag to true as the library is in a early stage (not yet stable).

Install dependencies

Now, you have define your dependencies, you can install them:

$ composer install

Composer will automatically download your dependencies & create an autoload file in the vendor directory.

Autoload

So easy, you just have to require the generated autoload file and you are already ready to play:

<?php

require __DIR__.'/vendor/autoload.php';

use Widop\Twitter\Rest;

// ...

The Wid'op Twitter library follows the PSR-0 Standard. If you prefer install it manually, it can be autoload by any convenient autoloader.