Skip to content

Commit

Permalink
Added readme description
Browse files Browse the repository at this point in the history
  • Loading branch information
chajr committed Aug 8, 2020
1 parent b026449 commit fa94ad3
Showing 1 changed file with 77 additions and 1 deletion.
78 changes: 77 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,77 @@
# symfony-console-style
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)

0 comments on commit fa94ad3

Please sign in to comment.