Added some documentation

m4tthumphrey · m4tthumphrey · commit 9b8ad509eb44 · 2013-04-12T11:43:59.000+01:00
diff --git a/README.md b/README.md
@@ -1,8 +1,88 @@
-php-gitlab-api
+A PHP Wrapper for use with the [Gitlab API](https://github.com/gitlabhq/gitlabhq/tree/master/doc/api).
 ==============
 
 Based on [php-github-api](https://github.com/m4tthumphrey/php-github-api) and code from [KnpLabs](https://github.com/KnpLabs/php-github-api).
 
+Installation
+------------
+Install Composer
+
+```
+$ curl -sS https://getcomposer.org/installer | php
+$ sudo mv composer.phar /usr/local/bin/composer
+```
+
+Add the following to your require block in composer.json config:
+
+```
+"m4tthumphrey/php-gitlab-api": "dev-master"
+```
+
+Include Composer's autoloader:
+
+
+```php
+require_once dirname(__DIR__).'/vendor/autoload.php';
+```
+
+General API Usage
+-----------------
+
+```php
+$gitlab = new \Gitlab\Client('http://git.yourdomain.com'/api/v3/'); // change here
+$gitlab->authenticate('your_gitlab_token_here', \Gitlab\Client::AUTH_URL_TOKEN); // change here
+
+$project = $gitlab->api('projects')->create('My Project', array(
+  'description' => 'This is a project'
+  'issues_enabled' => false
+));
+
+```
+
+Model Usage
+-----------
+
+You can also use the library in an object oriented manner. 
+
+```php
+$gitlab = new \Gitlab\Client('http://git.yourdomain.com'/api/v3/'); // change here
+$gitlab->authenticate('your_gitlab_token_here', \
+Gitlab\Client::AUTH_URL_TOKEN); // change here
+
+// Give the API client instance to model classes
+\Gitlab\Model\AbstractModel::client($gitlab);
+```
+
+Creating a new project
+
+```php
+$project = \Gitlab\Model\Project::create('My Project', array(
+  'description' => 'This is my project',
+  'issues_enabled' => false
+));
+
+$project->addHook('http://mydomain.com/hook/push/1');
+
+```
+
+Creating a new issue
+
+```php
+$project = new \Gitlab\Model\Project(1);
+$issue = $project->createIssue('This does not work..', array(
+  'description' => 'This doesnt work properly. Please fix',
+  'assignee_id' => 2
+));
+```
+
+Closing that issue
+
+```php
+$issue->close();
+```
+
+You get the idea! Take a look around and please feel free to report any bugs.
+
 Contributing
 ------------
 
