Skip to content

Commit fbea2e9

Browse files
authored
Fix broken links in README (#2022)
1 parent e00daff commit fbea2e9

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

readme.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,27 @@
11
## Debugbar for Laravel
2+
23
![Unit Tests](https://github.com/fruitcake/laravel-debugbar/workflows/Unit%20Tests/badge.svg)
3-
[![Packagist License](https://img.shields.io/badge/Licence-MIT-blue)](http://choosealicense.com/licenses/mit/)
4+
[![Packagist License](https://img.shields.io/badge/Licence-MIT-blue)](https://choosealicense.com/licenses/mit)
45
[![Latest Stable Version](https://img.shields.io/packagist/v/fruitcake/laravel-debugbar?label=Stable)](https://packagist.org/packages/fruitcake/laravel-debugbar)
56
[![Total Downloads](https://img.shields.io/packagist/dt/barryvdh/laravel-debugbar?label=Downloads)](https://packagist.org/packages/fruitcake/laravel-debugbar)
6-
[![Fruitcake](https://img.shields.io/badge/Powered%20By-Fruitcake-b2bc35.svg)](https://fruitcake.nl/)
7+
[![Fruitcake](https://img.shields.io/badge/Powered%20By-Fruitcake-b2bc35.svg)](https://fruitcake.nl)
78

89
This is a package to integrate [PHP Debug Bar](https://github.com/php-debugbar/php-debugbar) with Laravel.
910
It includes a ServiceProvider to register the debugbar and attach it to the output. You can publish assets and configure it through Laravel.
1011
It bootstraps some Collectors to work with Laravel and implements a couple custom DataCollectors, specific for Laravel.
11-
It is configured to display Redirects and Ajax/Livewire Requests. (Shown in a dropdown)
12-
Read [the documentation](http://phpdebugbar.com/docs/) for more configuration options.
12+
It is configured to display Redirects and Ajax/Livewire Requests, which are shown in a dropdown.
13+
Read the [documentation](https://php-debugbar.com/docs) for more configuration options.
1314

1415
![Debugbar Dark Mode screenshot](https://github.com/fruitcake/laravel-debugbar/assets/973269/6600837a-8b2d-4acb-ab0c-158c9ca5439c)
1516

1617
> [!CAUTION]
1718
> Use the DebugBar only in development. Do not use Debugbar on publicly accessible websites, as it will leak information from stored requests (by design).
1819
1920
> [!WARNING]
20-
> It can also slow the application down (because it has to gather and render data). So when experiencing slowness, try disabling some of the collectors.
21+
> It can also slow the application down (because it has to gather and render data). So when experiencing slowness, try disabling some of the collectors.
2122
2223
This package includes some custom collectors:
24+
2325
- QueryCollector: Show all queries, including binding + timing
2426
- RouteCollector: Show information about the current Route.
2527
- ViewCollector: Show the currently loaded views. (Optionally: display the shared data)
@@ -32,10 +34,12 @@ This package includes some custom collectors:
3234
- CacheCollector: Display all cache events. (disabled by default)
3335

3436
Bootstraps the following collectors for Laravel:
37+
3538
- LogCollector: Show all Log messages
3639
- SymfonyMailCollector for Mail
3740

3841
And the default collectors:
42+
3943
- PhpInfoCollector
4044
- MessagesCollector
4145
- TimeDataCollector (With Booting and Application timing)
@@ -52,7 +56,7 @@ Require this package with composer. It is recommended to only require the packag
5256
composer require fruitcake/laravel-debugbar --dev
5357
```
5458

55-
> Note: The package name has changed to `fruitcake/laravel-debugbar`. If you're using `barryvdh/laravel-debugbar`,
59+
> Note: The package name has changed to `fruitcake/laravel-debugbar`. If you're using `barryvdh/laravel-debugbar`,
5660
> you can safely replace this with the new package name: `composer remove barryvdh/laravel-debugbar --dev --no-scripts`
5761
5862
> Tip: Use 'composer require fruitcake/laravel-debugbar:"^4@beta" --dev' flag to try the new 4.x Beta version!
@@ -130,13 +134,13 @@ If you want you can add your own DataCollectors, through the Container or the Fa
130134

131135
```php
132136
Debugbar::addCollector(new DebugBar\DataCollector\MessagesCollector('my_messages'));
133-
//Or via the App container:
137+
// Or via the App container:
134138
$debugbar = App::make('debugbar');
135139
$debugbar->addCollector(new DebugBar\DataCollector\MessagesCollector('my_messages'));
136140
```
137141

138142
By default, the Debugbar is injected just before `</body>`. If you want to inject the Debugbar yourself,
139-
set the config option 'inject' to false and use the renderer yourself and follow http://phpdebugbar.com/docs/rendering.html
143+
set the config option 'inject' to false and use the renderer yourself and follow https://php-debugbar.com/docs/rendering
140144

141145
```php
142146
$renderer = Debugbar::getJavascriptRenderer();
@@ -146,6 +150,7 @@ Note: Not using the auto-inject, will disable the Request information, because t
146150
You can add the default_request datacollector in the config as alternative.
147151

148152
## Enabling/Disabling on run time
153+
149154
You can enable or disable the debugbar during run time.
150155

151156
```php
@@ -174,15 +179,15 @@ Add the following extensions to your TwigBridge config/extensions.php (or regist
174179
'Fruitcake\LaravelDebugbar\Twig\Extension\Stopwatch',
175180
```
176181

177-
The Dump extension will replace the [dump function](http://twig.sensiolabs.org/doc/functions/dump.html) to output variables using the DataFormatter. The Debug extension adds a `debug()` function which passes variables to the Message Collector,
182+
The Dump extension will replace the [dump function](https://twig.symfony.com/doc/3.x/functions/dump.html) to output variables using the DataFormatter. The Debug extension adds a `debug()` function which passes variables to the Message Collector,
178183
instead of showing it directly in the template. It dumps the arguments, or when empty; all context variables.
179184

180185
```twig
181186
{{ debug() }}
182187
{{ debug(user, categories) }}
183188
```
184189

185-
The Stopwatch extension adds a [stopwatch tag](http://symfony.com/blog/new-in-symfony-2-4-a-stopwatch-tag-for-twig) similar to the one in Symfony/Silex Twigbridge.
190+
The Stopwatch extension adds a [stopwatch tag](https://symfony.com/blog/new-in-symfony-2-4-a-stopwatch-tag-for-twig) similar to the one in Symfony/Silex Twigbridge.
186191

187192
```twig
188193
{% stopwatch "foo" %}

0 commit comments

Comments
 (0)