wip

Author: mpociot

docs/_index.md

@@ -0,0 +1,4 @@
+---
+packageName: Laravel Dump Server
+githubUrl: https://github.com/beyondcode/laravel-dump-server
+---

docs/installation.md

@@ -0,0 +1,30 @@
+---
+title: Installation
+order: 1
+---
+# Laravel Dump Server
+
+Bringing the Symfony Var-Dump Server to Laravel.
+
+This package will give you a dump server, that collects all your dump call outputs, so that it does not interfere with HTTP / API responses.
+
+![Dump Server Demo](/img/example.gif)
+
+# Installation
+
+You can install the package via composer:
+
+```bash
+composer require --dev beyondcode/laravel-dump-server
+```
+
+The package will register itself automatically. 
+
+Optionally you can publish the package configuration using:
+
+```bash
+php artisan vendor:publish --provider="BeyondCode\DumpServer\DumpServerServiceProvider"
+```
+
+This will publish a file called `debug-server.php` in your `config` folder.
+In the config file, you can specify the dump server host that you want to listen on, in case you want to change the default value.

docs/usage.md

@@ -0,0 +1,22 @@
+---
+title: Usage
+order: 2
+---
+
+# Usage
+
+Start the dump server by calling the artisan command:
+
+```bash
+php artisan dump-server
+```
+
+You can set the output format to HTML using the `--format` option:
+
+```bash
+php artisan dump-server --format=html > dump.html
+```
+
+Now you can put regular `dump` statements in your code. Instead of dumping the output directly in the HTTP response, the dumped data will be shown inside of your terminal / the running artisan command.
+
+This is very useful, when you want to dump data from API requests, without having to deal with HTTP errors.