From 3ecd3aae3a0e86b6d8c3235ece1d2ec4946608c1 Mon Sep 17 00:00:00 2001 From: roxblnfk Date: Thu, 20 Jun 2024 22:48:59 +0400 Subject: [PATCH] docs: update installation and about sections --- README.md | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 28acb737..ae34b9c7 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,13 @@
-**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 +``` + + ## Overview Buggregator Trap provides a toolkit for use in your code. Firstly, just having Buggregator Trap in your