Add documentation and Laravel 7 support

Author: mpociot

.gitignore

@@ -1,6 +1,5 @@
 build
 composer.lock
-docs
 vendor
 coverage
 .idea

composer.json

@@ -17,10 +17,10 @@
     ],
     "require": {
         "php": "^7.1",
-        "illuminate/support": "5.6.*|5.7.*|5.8.*|^6.0"
+        "illuminate/support": "5.6.*|5.7.*|5.8.*|^6.0|^7.0"
     },
     "require-dev": {
-        "orchestra/testbench": "^3.6|^3.7|^3.8|^4.0",
+        "orchestra/testbench": "^3.6|^3.7|^3.8|^4.0|^5.0",
         "phpunit/phpunit": "^7.0|^8.0",
         "spatie/phpunit-snapshot-assertions": "^1.3|^2.0"
     },

docs/_index.md

@@ -0,0 +1,4 @@
+---
+packageName: Laravel View Xray
+githubUrl: https://github.com/beyondcode/laravel-view-xray
+---

docs/disabling.md

@@ -0,0 +1,16 @@
+---
+title: Disabling Xray
+order: 2
+---
+
+## Disabling Xray
+
+You can disable Xray by setting an environment variable called `XRAY_ENABLED` to `false`.
+
+If you want to customize how xray should be enabled/disabled, you can publish the package configuration file using:
+
+```bash
+php artisan vendor:publish --provider=BeyondCode\\ViewXray\\ViewXrayServiceProvider
+``` 
+
+And modify the `enabled` key in the configuration file.

docs/excluding-views.md

@@ -0,0 +1,41 @@
+---
+title: Excluding views
+order: 3
+---
+
+# Excluding views
+
+If you want to exclude certain views from being processed by Xray, you can do this by adding them to the configuration file.
+
+Publish the configuration file using:
+
+```shell
+php artisan vendor:publish --provider=BeyondCode\\ViewXray\\ViewXrayServiceProvider
+``` 
+
+This will publish a file called `xray.php` in your `config` folder.
+
+This is the content of the configuration file:
+
+@verbatim
+```php
+return [
+
+    /*
+     * Determines if the Xray package should be enabled.
+     */
+    'enabled' => env('XRAY_ENABLED', true),
+
+    /*
+     * If you want to exclude certain views from being processed by Xray,
+     * you can list them here. Be aware that the check only applies to the
+     * root views that you add here. If these views include other views
+     * themselves, they need to be excluded manually.
+     */
+    'excluded' => [
+        //
+    ],
+
+];
+```
+@endverbatim

docs/faq.md

@@ -0,0 +1,20 @@
+---
+title: VueJS support
+order: 10
+---
+
+# FAQ
+
+To make this package work in combination with VueJS you need to enable comments in your VueJS app. 
+
+This package works by adding specific HTML comments into the rendered views and uses
+these comments to find the bounding boxes of the rendered HTML. VueJS by default removes HTML comments prior to rendering.
+
+You can enable HTML comments in your VueJS app by setting `comments` to `true`:
+
+```javascript
+let app = new Vue({
+    el: '#content',
+    comments: true
+});
+```

docs/installation.md

@@ -0,0 +1,22 @@
+---
+title: Installation
+order: 1
+---
+![Example output](https://beyondco.de/github/xray/xray.png)
+
+# Installation
+
+You can install the package via composer:
+
+```
+composer require beyondcode/laravel-view-xray --dev
+```
+
+Please make sure that you install this package as a dev dependency, as it could expose your internal view structure to others.
+
+The package is enabled by default - so all you need to do is visit your application in the browser and hit the Xray shortcut.
+
+- Windows: CTRL + Shift + X
+- OSX: CMD + Shift + X
+
+This toggles the Xray view, where you can see which view (and optionally section) rendered the visual output.