-
-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update installation and about sections
- Loading branch information
Showing
1 changed file
with
27 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -17,9 +17,13 @@ | |
|
||
<br /> | ||
|
||
**Buggregator Trap** is a minified version of the [Buggregator Server](https://github.com/buggregator/server) | ||
in the form of a terminal application and a set of utilities to assist with debugging. | ||
The package is designed to enhance the debugging experience in conjunction with the Buggregator Server. | ||
**Trap** is a package designed to enhance the debugging experience in conjunction with the Buggregator Server. | ||
Trap includes: | ||
|
||
- A set of functions for direct interaction with any Buggregator server. | ||
- Extensions for Symfony VarDumper that become active immediately after installing Trap. | ||
- A minimized version of the [Buggregator Server](https://github.com/buggregator/server) that does not require Docker | ||
and is intended solely for local use. | ||
|
||
- [Installation](#installation) | ||
- [Overview](#overview) | ||
|
@@ -43,6 +47,26 @@ composer require --dev buggregator/trap -W | |
|
||
And that's it. Trap is [ready to go](#usage). | ||
|
||
### Phar | ||
|
||
Sometimes your project may conflict with Trap's dependencies, or you might be interested in using only the local | ||
server (e.g., for analyzing local profiler files). | ||
In this case, consider installing Trap as a Phar (a self-contained PHP executable). | ||
Using wget: | ||
|
||
```bash | ||
wget https://github.com/buggregator/trap/releases/latest/download/trap.phar | ||
chmod +x trap.phar | ||
./trap.phar --version | ||
``` | ||
|
||
Using [Phive](https://phar.io/): | ||
|
||
```bash | ||
phive install buggregator/trap | ||
``` | ||
|
||
|
||
Check failure on line 69 in README.md GitHub Actions / markdown-lintingMultiple consecutive blank lines
|
||
## Overview | ||
|
||
Buggregator Trap provides a toolkit for use in your code. Firstly, just having Buggregator Trap in your | ||
|