From faa78434e409f15822a4e7e3e76b28bc6d5aba83 Mon Sep 17 00:00:00 2001 From: Susie Sahim Date: Sun, 9 Feb 2020 12:33:02 -0800 Subject: [PATCH] Add installation instructions for composer Composer is a popular way to ingest PHP code these days. This project already supports composer but did not yet have installation instructions. Adding those for convenience for future users. --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index e84cbbf..8c0fec1 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,22 @@ ConvertKit's official PHP SDK ### Installation +#### Standard installation + 1. Download or clone this repository 2. Run `composer install` 3. Add `./vendor/autoload.php` to your project +#### Installation with package manager + +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. + +```shell +composer require convertkit/convertkitapi:dev-master +``` + +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. + ### Usage Get your ConvertKit API Key and API Secret [here](https://app.convertkit.com/account/edit) and set it somewhere in your application.