Skip to content

Commit 36d59f7

Browse files
committed
readme: added "How it works" section
1 parent 27c3e2a commit 36d59f7

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,5 +48,30 @@ To install the plugin from the IDE built-in plugin system, go to IDEA <kbd>Setti
4848
4949
## Overview
5050

51+
### How it works:
52+
53+
By default, when started, the plugin tries to run Trap from the vendor folder using the PHP interpreter set in the project settings.
54+
The parameters specified in the plugin settings are passed to Trap.
55+
56+
![Options](resources/options.png)
57+
58+
> [!NOTE]
59+
> Therefore:
60+
> - You need to have [`buggregator/trap`](https://github.com/buggregator/trap) installed in your project.
61+
> - You can change the PHP interpreter in the plugin settings if needed.
62+
> - You can change the path to Trap in the plugin settings.
63+
64+
The plugin provides two channels for receiving information from Trap as separate tabs:
65+
- Web UI — an interactive Buggregator interface that opens in the IDE's built-in browser.
66+
- Terminal — displays information in text form.
67+
68+
Trap opens the Web interface port specified in the settings, which works well with many clients.
69+
Click the <kbd>🌐</kbd> button on the toolbar to open the Web UI in the system browser.
70+
71+
If you use the plugin in multiple running IDEs with the same port settings, both Web UIs will work with the same Trap.
72+
Another Trap instance will wait for the port to be free.
73+
74+
## Future scope
75+
5176
Currently, the plugin only works for launching [Buggregator Trap](https://github.com/buggregator/trap) from the vendor directory (or any other), but we are working on making it compatible with the [Buggregator server application](https://github.com/buggregator/server) as well.
5277

resources/options.png

27.8 KB
Loading

0 commit comments

Comments
 (0)