Merge 30781ce into 76e24ba

README.md

@@ -4,6 +4,60 @@
 [![Travis Build Status](https://img.shields.io/travis/lmc-eu/matej-client-php/master.svg?style=flat-square)](https://travis-ci.org/lmc-eu/matej-client-php)
 [![Coverage Status](https://img.shields.io/coveralls/lmc-eu/matej-client-php/master.svg?style=flat-square)](https://coveralls.io/r/lmc-eu/matej-client-php?branch=master)
 
+## Still using PHP 5.6?
+
+This library requires PHP 7.1. However we provide also PHP 5.6-compatible version [`matej-client-php5`](https://github.com/lmc-eu/matej-client-php5).
+
+Please note the PHP 5.6 version is just transpiled copy of this library - all development, issues, changelog etc. is placed in this repository.
+
+## Installation
+
+Library is installed using [Composer](https://getcomposer.org/).
+
+Matej API client library uses [HTTPlug](https://github.com/php-http/httplug) abstraction, so it is not hard coupled to
+any specific HTTP library, allowing you to use HTTP library which fits your needs (or maybe HTTP library you already use).
+
+This means that besides the `lmc/matej-client` library itself you must install an package which provides
+`php-http/client-implementation` - see [list of supported clients and adapters](http://docs.php-http.org/en/latest/clients.html).
+
+If you for example want to use Guzzle 6 as the underlying HTTP library, install package like this:
+
+```sh
+$ composer require lmc/matej-client php-http/guzzle6-adapter # use lmc/matej-client-php5 instead for PHP 5.6 version
+```
+
+Or if you want to use cURL client:
+
+```sh
+$ composer require lmc/matej-client php-http/curl-client guzzlehttp/psr7 # use lmc/matej-client-php5 instead for PHP 5.6 version
+```
+
+## Usage
+
+```php
+$matej = new Matej('accountId', 'apikey');
+
+// Create new item property in database:
+$response = $matej->request()
+    ->setupItemProperties()
+    ->addProperty(ItemPropertySetup::timestamp('valid_to'))
+    ->addProperty(ItemPropertySetup::string('title'))
+    ->send();
+
+// Delete item property from database:
+$response = $matej->request()
+    ->deleteItemProperties()
+    ->addProperty(ItemPropertySetup::timestamp('valid_from'))
+    ->addProperty(ItemPropertySetup::string('title'))
+    ->send();
+
+// Send item property data to database
+$response = $matej->request()
+    ->events()
+    ->addItemProperty(ItemProperty::create('1337', ['valid_from' => time(), 'title' => 'Title']))
+    ->send();
+```
+
 ## Changelog
 For latest changes see [CHANGELOG.md](CHANGELOG.md) file. We follow [Semantic Versioning](http://semver.org/).