Merge pull request #10 from madewithlove/feature/docs

Updated documentation with usage information.

Author: Xavier Barbosa

composer.json

@@ -1,17 +1,19 @@
 {
   "name": "madewithlove/laravel-debug-console",
+  "description": "Works as a console viewer for laravel debugbar.",
+  "keywords": ["laravel", "debugbar", "debug", "console"],
   "license": "MIT",
-  "description": "Works as a console view for laravel debug bar.",
   "authors": [
     {
-      "name": "Xavier Barbosa",
-      "email": "xavier@madewithlove.be"
+      "name": "madewithlove",
+      "email": "heroes@madewithlove.be"
     }
   ],
   "require": {
-    "illuminate/console": ">5.3",
-    "barryvdh/laravel-debugbar": ">2.4",
-    "clue/stdio-react": "^2.1"
+    "php": ">=5.5.9",
+    "illuminate/console": "5.1.*|5.2.*|5.3.*|5.4.*|5.5.*|5.6.*",
+    "barryvdh/laravel-debugbar": "~2.4|~3.1",
+    "clue/stdio-react": "~2.1"
   },
   "autoload": {
     "psr-4": {

readme.md

@@ -1,29 +1,25 @@
 # Laravel Debug Console
 
-Lets you keep an eye on your laravel application without intefering with your application response.
-Perfect if you are working with apis.
+Use as an alternative to view collected information from [Laravel Debugbar](https://github.com/barryvdh/laravel-debugbar) package.
+Useful if you are building apis or running console commands.
 
-## Installation instructions
+![php artisan app:debug queries](https://user-images.githubusercontent.com/3688705/41133243-9a32d442-6abd-11e8-9600-18c089440967.png)
 
-This package is still in development and not on packagist. To test it you can install it by adding it
-has a repository to your composer.json file.
+## Installation
 
-```json
-"repositories": [
-    {
-        "type": "path",
-        "url": "../laravel-debug-console-package"
-    }
-],
-"require-dev": {
-    "madewithlove/laravel-debug-console": "*"
-},
-"minimum-stability": "dev",
-"prefer-stable": true
+You can install the latest version via [composer](https://getcomposer.org/):
+```bash
+composer require --dev madewithlove/laravel-debug-console
 ```
 
-and then run `composer update`.
+Add the service provider to `config/app.php` if you are on laravel 5.4 or bellow:
+```php
+'providers' => [
+    // ...
+    Madewithlove\LaravelDebugConsole\ServiceProvider::class
+]
+```
 
 ## Usage
 
-Open your console and run `php artisan app:debug` it will update automatically on the next request.
+Open your console and run `php artisan app:debug [messages|timeline|exceptions|route|queries|request]` same options that are available by default on Laravel Debugbar.