diff --git a/README.md b/README.md index 85bdcd4..46de6cf 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ XeroOAuth-PHP PHP library for working with the Xero OAuth API. +[![Latest Stable Version](https://poser.pugx.org/xero/xerooauth-php/v/stable)](https://packagist.org/packages/xero/xerooauth-php) [![Total Downloads](https://poser.pugx.org/xero/xerooauth-php/downloads)](https://packagist.org/packages/xero/xerooauth-php) [![Latest Unstable Version](https://poser.pugx.org/xero/xerooauth-php/v/unstable)](https://packagist.org/packages/xero/xerooauth-php) [![License](https://poser.pugx.org/xero/xerooauth-php/license)](https://packagist.org/packages/xero/xerooauth-php) + Intro ====== XeroOAuth-PHP is a sample library for use with the Xero API (). The Xero API uses OAuth 1.0a, but we would not recommend using this library for other OAuth 1.0a APIs as @@ -15,6 +17,11 @@ This library is designed to get a developer up and running quickly with the OAut * php\_curl extension - ensure a recent version (7.30+) * php\_openssl extension +## Install +Either download and include, or install via Composer: +``` +composer require xero/xerooauth-php +``` ## Setup To get setup, you will need to modify the values in the \_config.php file to your own requirements and application settings or see the customised example file for each different application type, public.php, private.php or partner.php.