Skip to content

Commit 0cd6806

Browse files
author
Travis Northcutt
authored
Merge pull request #13 from bogusred/composer-install
Add installation instructions for composer
2 parents 6ee9f03 + faa7843 commit 0cd6806

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,22 @@ ConvertKit's official PHP SDK
33

44
### Installation
55

6+
#### Standard installation
7+
68
1. Download or clone this repository
79
2. Run `composer install`
810
3. Add `./vendor/autoload.php` to your project
911

12+
#### Installation with package manager
13+
14+
If your project uses [Composer](https://getcomposer.org/), you can install the ConvertKitSDK-PHP package as a composer package. This allows you to have this project as a dependency without the ConvertKitSDK-PHP files being checked into your source code.
15+
16+
```shell
17+
composer require convertkit/convertkitapi:dev-master
18+
```
19+
20+
Please note that since ConvertKitSDK-PHP is not yet versioned, your project will always download the latest files from master every time you run `composer install` which may subject you to breaking changes in the future.
21+
1022
### Usage
1123

1224
Get your ConvertKit API Key and API Secret [here](https://app.convertkit.com/account/edit) and set it somewhere in your application.

0 commit comments

Comments
 (0)