Tabs API Client

Getting Started

To get started with this project you can either clone the repo into your project or alternatively install it via composer.

Installing via git

1. Navigate to the directory you wish to add the project.
2. Clone the repo either via ssh, svn or zip.
3. If you're not familiar with git, please see this helpful guide.

Installing via composer

1. Create a composer.json where you want to install the project
2. Add the following:

{
	"repositories": [
		{
			"type": "vcs",
			"url": "git@github.com:CarltonSoftware/tabs-api-client.git"
		}
	],
	"require": {
		"carltonsoftware/tabs-api-client": "dev-master"	
	}
}

3: Download composer and install the repo:

curl -sS https://getcomposer.org/installer | php
./composer.phar install

For more information about composer, please see the composer quick start guide.

4: Regenerating documentation

// cd into root of api client folder
git summodule init
git submodule update
phpdoc -d ./src/ -t ./tabs-api-client-example-docs/docs

Downloading a version

We would recommend a downloading the latest release (v2.1) which can be found in the releases view.