From fa94ad319ddd843b91463c36e56ab9d6871fa79a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Micha=C5=82=20Adamiak?= <chajr@bluetree.pl>
Date: Sat, 8 Aug 2020 19:31:55 +0200
Subject: [PATCH] Added readme description

---
 README.md | 78 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 77 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 30e5768..b34519f 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,77 @@
-# symfony-console-style
\ No newline at end of file
+Bluetree Symfony Console Styles Extender
+========================================
+
+[![Latest Stable Version](https://poser.pugx.org/bluetree-service/symfony-console-style/v/stable.svg?style=flat-square)](https://packagist.org/packages/bluetree-service/symfony-console-style)
+[![Total Downloads](https://poser.pugx.org/bluetree-service/symfony-console-style/downloads.svg?style=flat-square)](https://packagist.org/packages/bluetree-service/symfony-console-style)
+[![License](https://poser.pugx.org/bluetree-service/symfony-console-style/license.svg?style=flat-square)](https://packagist.org/packages/bluetree-service/symfony-console-style)
+
+##### Builds
+| Travis | Scrutinizer |
+|:---:|:---:|
+| [![Build Status](https://travis-ci.org/bluetree-service/symfony-console-style.svg?style=flat-square)](https://travis-ci.org/bluetree-service/symfony-console-style) | [![Build Status](https://scrutinizer-ci.com/g/bluetree-service/symfony-console-style/badges/build.png?style=flat-square&b=master)](https://scrutinizer-ci.com/g/bluetree-service/symfony-console-style/build-status/master) |
+
+##### Coverage
+| Coveralls | Scrutinizer |
+|:---:|:---:|
+| [![Coverage Status](https://coveralls.io/repos/github/bluetree-service/symfony-console-style/badge.svg?style=flat-square&branch=master)](https://coveralls.io/github/bluetree-service/symfony-console-style?branch=master) | [![Code Coverage](https://scrutinizer-ci.com/g/bluetree-service/symfony-console-style/badges/coverage.png?style=flat-square&b=master)](https://scrutinizer-ci.com/g/bluetree-service/symfony-console-style/?branch=master) |
+
+##### Quality
+| Code Climate | Scrutinizer | Sensio Labs |
+|:---:|:---:|:---:|
+| [![Code Climate](https://codeclimate.com/github/bluetree-service/symfony-console-style/badges/gpa.svg?style=flat-square)](https://codeclimate.com/github/bluetree-service/symfony-console-style) | [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/bluetree-service/symfony-console-style/badges/quality-score.png?style=flat-square&b=master)](https://scrutinizer-ci.com/g/bluetree-service/symfony-console-style/?branch=master) | [![SensioLabsInsight](https://insight.sensiolabs.com/projects/e9b6307b-4407-4fbe-8e40-233a3ec7f352/mini.png?style=flat-square)](https://insight.sensiolabs.com/projects/e9b6307b-4407-4fbe-8e40-233a3ec7f352) |
+|  | [![Code Intelligence Status](https://scrutinizer-ci.com/g/bluetree-service/symfony-console-style/badges/code-intelligence.svg?style=flat-square&b=master)](https://scrutinizer-ci.com/code-intelligence) |  |
+
+Extended Symfony Console styles. Including new blocks, message time, interactive checkboxes and many others. 
+
+### Included libraries
+* **BlueStyle\MultiSelect** - Handle single & multi select
+* **BlueStyle\Style** - Nes styles
+
+Documentation & Examples
+------------------------
+* [Multi select](https://github.com/bluetree-service/symfony-console-style/tree/examples/multiselect.php "Multi select")
+* [Single select](https://github.com/bluetree-service/symfony-console-style/tree/develop/singleselect.pl "Single select")
+* [Extended styles](https://github.com/bluetree-service/symfony-console-style/tree/develop/style.php "Extended styles")
+
+
+Install via Composer
+--------------
+To use packages you can just download package and pace it in your code. But recommended
+way to use _BlueConsole_ is install it via Composer. To include _BlueConsole_
+libraries paste into composer json:
+
+```json
+{
+    "require": {
+        "bluetree-service/symfony-console-style": "version_number"
+    }
+}
+```
+
+Project description
+--------------
+
+### Used conventions
+
+* **Namespaces** - each library use namespaces
+* **PSR-2** - [PSR-2](http://www.php-fig.org/psr/psr-2/) coding standard
+* **PSR-4** - [PSR-4](http://www.php-fig.org/psr/psr-4/) auto loading standard
+* **Composer** - [Composer](https://getcomposer.org/)
+
+### Requirements
+
+* PHP 7.2 or higher
+
+Change log
+--------------
+All release version changes:  
+[Change log](https://github.com/bluetree-service/symfony-console-style/tree/develop/doc/changelog.md "Change log")
+
+License
+--------------
+This bundle is released under the Apache license.  
+[Apache license](https://github.com/bluetree-service/symfony-console-style/LICENSE "Apache license")
+
+Travis Information
+--------------
+[Travis CI Build Info](https://travis-ci.org/bluetree-service/symfony-console-style)