diff --git a/README.md b/README.md index fc4505b..4b30d0e 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,36 @@ IntaroCRM REST API client PHP Client for [IntaroCRM REST API](http://docs.intarocrm.ru/rest-api/). -Requirements: +Requirements +------------ * PHP version 5.2 and above * PHP-extension CURL + +Installation +------------ + +Add IntaroCRM REST API client in your composer.json: + +```js +{ + "require": { + "intaro/crm-rest-api": "1.0.*" + } +} +``` +Usage +------------ + +### Create API clent class + +``` php + + $crmApiClient = new \IntaroCrmRestApi('http://demo.intarocrm.ru', 'T9DMPvuNt7FQJMszHUdG8Fkt6xHsqngH'); + +``` +Constructor arguments are: + +1. IntaroCRM url address. +2. Your site API Token. + diff --git a/composer.json b/composer.json index d9f7ae8..2e000ee 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,6 @@ { - "name": "intaro/crm-rest-api", - "description": "PHP class that provides a simple way to interact with Intaro CRM Rest API", + "name": "intarocrm/crm-rest-api", + "description": "PHP Client for IntaroCRM REST API", "type": "library", "keywords": ["api", "Intaro CRM"], "homepage": "http://www.intarocrm.ru/", @@ -19,11 +19,11 @@ "email": "support@intarocrm.ru" }, "autoload": { - "psr-0": { "Intaro": "lib/" } + "psr-0": { "IntaroCRM": "lib/" } }, "extra": { "branch-alias": { - "dev-master": "1.0.x-dev" + "dev-master": "1.0.x" } } } \ No newline at end of file