Skip to content

Commit b6d8020

Browse files
authored
Update README.md
1 parent 0eec6fd commit b6d8020

File tree

1 file changed

+2
-40
lines changed

1 file changed

+2
-40
lines changed

README.md

+2-40
Original file line numberDiff line numberDiff line change
@@ -8,47 +8,9 @@ Bringing the [Symfony Var-Dump Server](https://symfony.com/doc/current/component
88

99
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.
1010

11-
> If you want to learn how to create reusable PHP packages yourself, take a look at my upcoming [PHP Package Development](https://phppackagedevelopment.com) video course.
11+
## Documentation
1212

13-
## Installation
14-
15-
You can install the package via composer:
16-
17-
```bash
18-
composer require --dev beyondcode/laravel-dump-server
19-
```
20-
21-
The package will register itself automatically.
22-
23-
Optionally you can publish the package configuration using:
24-
25-
```bash
26-
php artisan vendor:publish --provider=BeyondCode\\DumpServer\\DumpServerServiceProvider
27-
```
28-
29-
This will publish a file called `debug-server.php` in your `config` folder.
30-
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.
31-
32-
## Usage
33-
34-
Start the dump server by calling the artisan command:
35-
36-
```bash
37-
php artisan dump-server
38-
```
39-
40-
You can set the output format to HTML using the `--format` option:
41-
42-
```bash
43-
php artisan dump-server --format=html > dump.html
44-
```
45-
46-
And then you can, as you are used to, put `dump` calls in your methods. But instead of dumping the output in your current HTTP request, they will be dumped in the artisan command.
47-
This is very useful, when you want to dump data from API requests, without having to deal with HTTP errors.
48-
49-
You can see it in action here:
50-
51-
![Dump Server Demo](https://beyondco.de/github/dumpserver/dumpserver.gif)
13+
You can find the documentation on the [Beyond Code website](https://beyondco.de/docs/laravel-dump-server/installation).
5214

5315
### Changelog
5416

0 commit comments

Comments
 (0)