Skip to content

Commit

Permalink
small tweaks to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
scottusrobus committed Nov 23, 2015
1 parent 4037cd9 commit af14703
Showing 1 changed file with 9 additions and 14 deletions.
23 changes: 9 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
# VHX PHP Node Bindings
# VHX PHP API Client (BETA)

You can sign up for a VHX account at https://vhx.tv.

### Requirements

PHP 5.3.3 and later.

### Installation
Requires PHP 5.3.3 and later.

**Composer**

Expand Down Expand Up @@ -42,23 +39,21 @@ require_once('/path/to/vhx-php/init.php');

### Documentation

Documentation is available at http://dev.vhx.tv/docs/api/php.
Full API reference is available at http://dev.vhx.tv/docs/api?php.
Documentation, including a step-by-step tutorial is available on the [VHX Developer Docs ](http://dev.vhx.tv/api?php) site.
For Full API reference [go here](http://dev.vhx.tv/docs/api?php).

### Getting Started

Every resource is accessed via the `\VHX` namespace:
Before requesting your first resource, you must setup your instance with your VHX API key:

```php
\VHX\API::setKey('your VHX API key');
```

Every resource method has one arguments. The argument is an options array.
Every resource is accessed via the `\VHX` namespace:

```php

// \VHX\{resource}::{method}(options);

// example customer create
$customer = \VHX\Customers::create(array(
email => '[email protected]',
Expand All @@ -67,8 +62,6 @@ $customer = \VHX\Customers::create(array(
});
```

You can get a step-by-step tutorial on how to use the [VHX PHP API on our developer docs](https://dev.vhx.tv/api#php).

### Resources & methods

videos
Expand All @@ -83,7 +76,9 @@ collections
* [`retrieve`](http://dev.vhx.tv/docs/api?php#retrieve_collection)
* [`list`](http://dev.vhx.tv/docs/api?php#list_collections)

customers
[`items`](http://dev.vhx.tv/docs/api?php#list_collection_items)

customers
* [`create`](http://dev.vhx.tv/docs/api?php#create_customer)
* [`update`](http://dev.vhx.tv/docs/api?php#update_customer)
* [`retrieve`](http://dev.vhx.tv/docs/api?php#retrieve_customer)
Expand Down

1 comment on commit af14703

@jamiew
Copy link

@jamiew jamiew commented on af14703 Nov 23, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whoa go robus!

Please sign in to comment.