From 697928fffb30e711fd19d7475d1df00f957787fc Mon Sep 17 00:00:00 2001 From: James Bell Date: Sat, 16 Jul 2016 22:51:34 +0100 Subject: [PATCH] Updated readme --- composer.json | 2 +- readme.md | 30 +++++++++++------------------- 2 files changed, 12 insertions(+), 20 deletions(-) diff --git a/composer.json b/composer.json index e0cf6f1..07e52d0 100644 --- a/composer.json +++ b/composer.json @@ -2,7 +2,7 @@ "name": "jamesryanbell/cloudflare", "description": "Cloudflare API V4 PHP wrapper", "license": "MIT", - "version": "1.6.3", + "version": "1.6.4", "keywords": ["cloudflare", "api"], "authors": [ { diff --git a/readme.md b/readme.md index ebf6d03..9493593 100644 --- a/readme.md +++ b/readme.md @@ -1,27 +1,19 @@ -[![Build Status](https://travis-ci.org/jamesryanbell/cloudflare.svg?branch=master)](https://travis-ci.org/jamesryanbell/cloudflare) -[![Coverage Status](https://img.shields.io/coveralls/jamesryanbell/cloudflare.svg)](https://coveralls.io/r/jamesryanbell/cloudflare?branch=master) -[![Dependency Status](http://www.versioneye.com/user/projects/53e78e96e09a429c6200000a/badge.svg?style=flat)](http://www.versioneye.com/user/projects/53e78e96e09a429c6200000a) +[![Build Status](https://travis-ci.org/jamesryanbell/cloudflare.svg?branch=master)](https://travis-ci.org/jamesryanbell/cloudflare) [![Coverage Status](https://img.shields.io/coveralls/jamesryanbell/cloudflare.svg)](https://coveralls.io/r/jamesryanbell/cloudflare?branch=master) [![Dependency Status](http://www.versioneye.com/user/projects/53e78e96e09a429c6200000a/badge.svg?style=flat)](http://www.versioneye.com/user/projects/53e78e96e09a429c6200000a) [![Latest Stable Version](https://poser.pugx.org/jamesryanbell/cloudflare/v/stable.svg)](https://packagist.org/packages/jamesryanbell/cloudflare) [![Total Downloads](https://poser.pugx.org/jamesryanbell/cloudflare/downloads.svg)](https://packagist.org/packages/jamesryanbell/cloudflare) [![License](https://poser.pugx.org/jamesryanbell/cloudflare/license.svg)](https://packagist.org/packages/jamesryanbell/cloudflare) -[![Latest Stable Version](https://poser.pugx.org/jamesryanbell/cloudflare/v/stable.svg)](https://packagist.org/packages/jamesryanbell/cloudflare) [![Total Downloads](https://poser.pugx.org/jamesryanbell/cloudflare/downloads.svg)](https://packagist.org/packages/jamesryanbell/cloudflare) [![Latest Unstable Version](https://poser.pugx.org/jamesryanbell/cloudflare/v/unstable.svg)](https://packagist.org/packages/jamesryanbell/cloudflare) [![License](https://poser.pugx.org/jamesryanbell/cloudflare/license.svg)](https://packagist.org/packages/jamesryanbell/cloudflare) +# CloudFlare API - PHP -[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/jamesryanbell/cloudflare/trend.png)](https://bitdeli.com/free "Bitdeli Badge") +The documentation for the API can be found at https://api.cloudflare.com, I will try to update this as soon as possible when new features are added to the API. If I miss one please submit a pull request. -#Cloudflare API V4 PHP wrapper +If you spot an issue with the package just let me know via issues but please include as much detail as possible, ideally with code examples, environment information etc. -A work in progress library for the Cloudflare API. The documentation for the API can be found at https://api.cloudflare.com. - -I have implemented all of the methods from the available documentation but if there are more just let me know via issues please https://github.com/jamesryanbell/cloudflare/issues - - -##Installation +## Installation Installation should be done via composer, details of how to install composer can be found at https://getcomposer.org/ +``` bash +$ composer require jamesryanbell/cloudflare +``` -Add `"jamesryanbell/cloudflare": "dev-master"` to your `composer.json` file - -Run `composer update` to install the latest version. - -##Usage +## Usage In situations where you want to make multiple calls to the API across different services it's easier to create a connection to the api first and then pass that around the other services e.g. @@ -47,5 +39,5 @@ If you are just performing a single action then you can connect to the API direc $dns->create('12345678901234567890', 'TXT', 'name.com', '127.0.0.1', 120); ``` -#License -MIT +# License +MIT \ No newline at end of file