Skip to content

Add syntax highlighting to readme #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
devidw wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add syntax highlighting to readme #121

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 36 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,25 @@ Both customers of our hosted platform and On-Site edition can use these files. O

You can install **activecampaign-api-php** by [downloading (.zip)](https://github.com/ActiveCampaign/activecampaign-api-php/zipball/master) or cloning the source:

`git clone git@github.com:ActiveCampaign/activecampaign-api-php.git`
```bash
git clone git@github.com:ActiveCampaign/activecampaign-api-php.git
```

### Composer

If you are using Composer, create your `composer.json` file ([example here](examples-composer/composer.json)).

Then load the `composer.phar` file in that directory:

`curl -sS https://getcomposer.org/installer | php`
```bash
curl -sS https://getcomposer.org/installer | php
```

Next, run install to load the ActiveCampaign library:

`php composer.phar install`
```bash
php composer.phar install
```

You should then see the `activecampaign` folder inside `vendor`.

Expand All @@ -36,41 +42,51 @@ You should then see the `activecampaign` folder inside `vendor`.

In your script just include the `autoload.php` file to load all classes:

`require "vendor/autoload.php";`
```php
require "vendor/autoload.php";
```

Next, create a class instance of `ActiveCampaign`:

`$ac = new ActiveCampaign("API_URL", "API_KEY");`
```php
$ac = new ActiveCampaign("API_URL", "API_KEY");
```

That's it!

### includes/config.php

define("ACTIVECAMPAIGN_URL", "API_URL");
define("ACTIVECAMPAIGN_API_KEY", "API_KEY");
```php
define("ACTIVECAMPAIGN_URL", "API_URL");
define("ACTIVECAMPAIGN_API_KEY", "API_KEY");
```

### examples.php

require_once("includes/ActiveCampaign.class.php");
```php
require_once("includes/ActiveCampaign.class.php");

$ac = new ActiveCampaign(ACTIVECAMPAIGN_URL, ACTIVECAMPAIGN_API_KEY);
$ac = new ActiveCampaign(ACTIVECAMPAIGN_URL, ACTIVECAMPAIGN_API_KEY);

// Adjust the default cURL timeout
$ac->set_curl_timeout(10);
// Adjust the default cURL timeout
$ac->set_curl_timeout(10);

$account = $ac->api("account/view");
$account = $ac->api("account/view");
```

Or just include everything in the same PHP file:

define("ACTIVECAMPAIGN_URL", "API_URL");
define("ACTIVECAMPAIGN_API_KEY", "API_KEY");
require_once("includes/ActiveCampaign.class.php");
$ac = new ActiveCampaign(ACTIVECAMPAIGN_URL, ACTIVECAMPAIGN_API_KEY);
```php
define("ACTIVECAMPAIGN_URL", "API_URL");
define("ACTIVECAMPAIGN_API_KEY", "API_KEY");
require_once("includes/ActiveCampaign.class.php");
$ac = new ActiveCampaign(ACTIVECAMPAIGN_URL, ACTIVECAMPAIGN_API_KEY);

// Adjust the default cURL timeout
$ac->set_curl_timeout(10);
// Adjust the default cURL timeout
$ac->set_curl_timeout(10);

$account = $ac->api("account/view");
$account = $ac->api("account/view");
```

See our [examples file](examples.php) for more in-depth samples.

Expand All @@ -80,4 +96,4 @@ See our [examples file](examples.php) for more in-depth samples.

## Reporting Issues

We'd love to help if you have questions or problems. Report issues using the [Github Issue Tracker](https://github.com/ActiveCampaign/activecampaign-api-php/issues) or email help@activecampaign.com.
We'd love to help if you have questions or problems. Report issues using the [Github Issue Tracker](https://github.com/ActiveCampaign/activecampaign-api-php/issues) or email help@activecampaign.com.