Skip to content

Commit

Permalink
Join the entire library into a single script package
Browse files Browse the repository at this point in the history
This allows the code to be used without requiring Composer
or Packagist.
  • Loading branch information
maetl committed Mar 29, 2013
1 parent ca7c081 commit 2927733
Show file tree
Hide file tree
Showing 6 changed files with 1,229 additions and 13 deletions.
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
vendor
./*.php
./*.sh
composer.lock
*.sh
29 changes: 19 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Bigcommerce API Client
======================

PHP package for connecting to the Bigcommerce V2 REST API.
PHP client for connecting to the Bigcommerce V2 REST API.

To find out more, visit the official documentation website:
http://developer.bigcommerce.com/
Expand All @@ -24,28 +24,37 @@ the 'Enable the XML API?' is ticked.
Installation
------------

Download the required PHP code for the Bigcommerce REST API client and copy it
to your PHP include path, or use the following Composer command to install the
Use the following Composer command to install the
API client from [the Bigcommerce vendor on Packagist](https://packagist.org/packages/bigcommerce/api):

```
$ composer require bigcommerce/api
$ composer update
```

All the examples below assume the `Bigcommerce\Api\Client` class is imported
into the scope with the following namespace declaration:

```
use Bigcommerce\Api\Client as Bigcommerce;
```
You can also install composer for this specific project by running the following in the library folder.
You can also install composer for your specific project by running the following in the library folder.

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

If you don’t want to use Composer and Packagist, the API client is also distributed as a single
PHP file (`bigcommerce.php`) which you can include directly into your project:

```
require 'path/to/bigcommerce.php';
```

Namespace
---------

All the examples below assume the `Bigcommerce\Api\Client` class is imported
into the scope with the following namespace declaration:

```
use Bigcommerce\Api\Client as Bigcommerce;
```

Configuration
Expand Down
Loading

0 comments on commit 2927733

Please sign in to comment.