Skip to content

Commit

Permalink
docs: update installation and about sections
Browse files Browse the repository at this point in the history
  • Loading branch information
roxblnfk committed Jun 20, 2024
1 parent 4893fc6 commit 3ecd3aa
Showing 1 changed file with 27 additions and 3 deletions.
30 changes: 27 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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

View workflow job for this annotation

GitHub Actions / markdown-linting

Multiple consecutive blank lines

README.md:69 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md012.md
## Overview

Buggregator Trap provides a toolkit for use in your code. Firstly, just having Buggregator Trap in your
Expand Down

0 comments on commit 3ecd3aa

Please sign in to comment.