Skip to content

Commit 2927733

Browse files
committed
Join the entire library into a single script package
This allows the code to be used without requiring Composer or Packagist.
1 parent ca7c081 commit 2927733

File tree

6 files changed

+1229
-13
lines changed

6 files changed

+1229
-13
lines changed

.gitignore

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
vendor
2-
./*.php
3-
./*.sh
2+
composer.lock
3+
*.sh

README.md

+19-10
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Bigcommerce API Client
22
======================
33

4-
PHP package for connecting to the Bigcommerce V2 REST API.
4+
PHP client for connecting to the Bigcommerce V2 REST API.
55

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

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

3130
```
3231
$ composer require bigcommerce/api
3332
$ composer update
3433
```
3534

36-
All the examples below assume the `Bigcommerce\Api\Client` class is imported
37-
into the scope with the following namespace declaration:
38-
39-
```
40-
use Bigcommerce\Api\Client as Bigcommerce;
41-
```
42-
You can also install composer for this specific project by running the following in the library folder.
35+
You can also install composer for your specific project by running the following in the library folder.
4336

4437
```
4538
curl -sS https://getcomposer.org/installer | php
4639
php composer.phar install
4740
composer install
41+
```
4842

43+
If you don’t want to use Composer and Packagist, the API client is also distributed as a single
44+
PHP file (`bigcommerce.php`) which you can include directly into your project:
45+
46+
```
47+
require 'path/to/bigcommerce.php';
48+
```
49+
50+
Namespace
51+
---------
52+
53+
All the examples below assume the `Bigcommerce\Api\Client` class is imported
54+
into the scope with the following namespace declaration:
55+
56+
```
57+
use Bigcommerce\Api\Client as Bigcommerce;
4958
```
5059

5160
Configuration

0 commit comments

Comments
 (0)