Skip to content

Commit

Permalink
updates readme
Browse files Browse the repository at this point in the history
  • Loading branch information
chasecoleman committed Jul 8, 2016
1 parent 5516cc7 commit 7a43590
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 249 deletions.
2 changes: 2 additions & 0 deletions .gitignore
@@ -1 +1,3 @@
vendor/
.DS_Store
composer.lock
35 changes: 30 additions & 5 deletions README.md
@@ -1,7 +1,35 @@
## ButterCMS PHP API Wrapper
This wrapper is meant to enable PHP developers to quickly and easily get up and running with [ButterCMS](https://buttercms.com/). It is based of off the [API documentation](https://buttercms.com/docs/api/).
# ButterCMS PHP API Wrapper

This wrapper enables PHP developers to quickly and easily get up and running with [ButterCMS](https://buttercms.com/). It is based of off the [API documentation](https://buttercms.com/docs/api/).

## Requirements

PHP 5.3.0 and later.

## Composer

You can install the bindings via [Composer](http://getcomposer.org/). Run the following command:

```bash
composer require stripe/stripe-php
```

To use the bindings, use Composer's [autoload](https://getcomposer.org/doc/00-intro.md#autoloading):

```php
require_once('vendor/autoload.php');
```

## Manual Installation

If you do not wish to use Composer, you can download the [latest release](https://github.com/stripe/stripe-php/releases). Then, to use the bindings, include the `init.php` file.

```php
require_once('/path/to/buttercms-php/src/ButterCMS.php');
```

## Example Usage

```php
use ButterCMS\ButterCMS;

Expand All @@ -26,6 +54,3 @@ $butterCms->getCategories(['include' => 'recent_posts']);
// Content Fields - returns your fields turned in to a multidimensional array
$butterCms->getContentFields(['headline', 'FAQ']);
```

## Composer Support
To install via Composer simply require `buttercms/api-wrapper` in your `composer.json` file.
6 changes: 3 additions & 3 deletions composer.json
@@ -1,10 +1,10 @@
{
"name": "buttercms/api-wrapper",
"name": "buttercms/buttercms-php",
"description": "ButterCMS PHP API Wrapper",
"authors": [
{
"name": "Josh Holat",
"email": "jholat@gmail.com"
"name": "ButterCMS",
"email": "support@buttercms.com"
}
],
"minimum-stability": "dev",
Expand Down
241 changes: 0 additions & 241 deletions composer.lock

This file was deleted.

0 comments on commit 7a43590

Please sign in to comment.