Merge branch 'master' of github.com:meritoo/common-library

# Conflicts:
#	README.md

README.md

@@ -1,9 +1,10 @@
 # Meritoo Common Library
+
 Common and useful classes, methods, exceptions etc.
 
-[![Travis](https://img.shields.io/travis/rust-lang/rust.svg?style=flat-square)](https://travis-ci.org/meritoo/common-library) [![Packagist](https://img.shields.io/packagist/v/meritoo/common-library.svg?style=flat-square)](https://packagist.org/packages/meritoo/common-library) [![StyleCI](https://styleci.io/repos/101790028/shield?branch=master)](https://styleci.io/repos/101790028) [![license](https://img.shields.io/github/license/meritoo/common-library.svg?style=flat-square)](https://github.com/meritoo/common-library) [![GitHub commits](https://img.shields.io/github/commits-since/meritoo/common-library/0.0.1.svg?style=flat-square)](https://github.com/meritoo/common-library) [![Coverage Status](https://coveralls.io/repos/github/meritoo/common-library/badge.svg?branch=master)](https://coveralls.io/github/meritoo/common-library?branch=master)
+[![Travis](https://img.shields.io/travis/rust-lang/rust.svg?style=flat-square)](https://travis-ci.org/meritoo/common-library) [![Packagist](https://img.shields.io/packagist/v/meritoo/common-library.svg?style=flat-square)](https://packagist.org/packages/meritoo/common-library) [![license](https://img.shields.io/github/license/meritoo/common-library.svg?style=flat-square)](https://github.com/meritoo/common-library) [![GitHub commits](https://img.shields.io/github/commits-since/meritoo/common-library/0.0.1.svg?style=flat-square)](https://github.com/meritoo/common-library) [![Coverage Status](https://coveralls.io/repos/github/meritoo/common-library/badge.svg?branch=master)](https://coveralls.io/github/meritoo/common-library?branch=master)
 
-## Installation
+# Installation
 
 In your `composer.json` add address of repository into `repositories` section:
 
@@ -20,107 +21,21 @@ In your `composer.json` add address of repository into `repositories` section:
 Run [Composer](https://getcomposer.org) to install this package in your project:
 
 ```bash
-$ composer require wiosna-dev/common-library
+composer require wiosna-dev/common-library
 ```
 
-> How to install Composer: https://getcomposer.org/download
+> [How to install Composer?](https://getcomposer.org/download)
 
-## Rebuilding project and tests running
+# Usage
 
-```bash
-$ docker-compose up -d
-$ docker-compose exec php-cli phing
-```
+1. [Base test case (with common methods and data providers)](docs/Base-test-case.md)
+2. [Collection of elements](docs/Collection-of-elements.md)
+3. [Exceptions](docs/Static-methods.md)
+4. [Static methods](docs/Static-methods.md)
+5. [Value Objects](docs/Value-Objects.md)
 
-> What is Docker? https://www.docker.com/what-docker
+# Development
 
-## Static methods
-
-This package contains a lot of class with static methods, so usage is not so complicated. Just run the static method who would you like to use. Example:
-
-```php
-use Meritoo\Common\Utilities\Arrays;
-
-$firstElement = Arrays::getFirstElement(['lorem', 'ipsum']);
-var_dump($firstElement); // string(5) "lorem"
-```
-
-## Base test case with common methods and data providers
-
-Located here: `Meritoo\Common\Test\Base\BaseTestCase`. Just extend the `BaseTestCase` class and use it like in `Meritoo\Common\Test\Utilities\DateTest` class:
-
-```php
-class DateTest extends BaseTestCase
-{
-    /**
-     * @param mixed $value Empty value, e.g. ""
-     * @dataProvider provideEmptyValue
-     */
-    public function testGetDateTimeEmptyValue($value)
-    {
-        self::assertFalse(Date::getDateTime($value));
-    }
-
-	(...)
-}
-```
-
-or in `Meritoo\Common\Test\Utilities\MimeTypesTest` class:
-
-```php
-class MimeTypesTest extends BaseTestCase
-{
-	(...)
-
-    /**
-     * @param bool $mimeType The mime type, e.g. "video/mpeg"
-     * @dataProvider provideBooleanValue
-     */
-    public function testGetExtensionBooleanMimeType($mimeType)
-    {
-        self::assertEquals('', MimeTypes::getExtension($mimeType));
-    }
-
-	(...)
-}
-```
-
-## Collection of elements
-
-Located here: `Meritoo\Common\Collection\Collection`. It's a set of some elements, e.g. objects. It's iterable and countable. Provides very useful methods. Some of them:
-- `getFirst()` - returns the first element in the collection
-- `getLast()` - returns the last element in the collection
-- `isEmpty()` - returns information if collection is empty
-- `add($element, $index = null)` - adds given element (at the end of collection)
-- `addMultiple($elements, $useIndexes = false)` - adds given elements (at the end of collection)
-- `prepend($element)` - prepends given element (adds given element at the beginning of collection)
-- `remove($element)` - removes given element
-
-Examples of usage below.
-
-#### An empty collection
-
-```php
-use Meritoo\Common\Collection\Collection;
-
-$emptyCollection = new Collection();
-var_dump($emptyCollection->isEmpty()); // bool(true)
-```
-
-#### Simple collection
-
-```php
-use Meritoo\Common\Collection\Collection;
-
-$elements = [
-    'lorem',
-    'ipsum',
-    123 => 'dolor',
-    345 => 'sit',
-];
-
-$simpleCollection = new Collection($elements);
-var_dump($simpleCollection->has('dolor')); // bool(true)
-```
+More information [you can find here](docs/Development.md)
 
 Enjoy!