Skip to content

Commit ee3953a

Browse files
committed
Update readme
1 parent c45b849 commit ee3953a

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,32 @@
88

99
</div>
1010

11+
<br />
12+
1113
The plugin integrates Buggregator into the JetBrains IDEs, allowing you to debug your code with ease.
1214
Now you don't need to switch to another window or screen to look at dumps and then back to run tests.
1315
Everything is in front of you, and all the shortcuts work.
1416

15-
![img.png](resources/img_1.png)
16-
17-
## Get started
17+
![overview.png](resources/img_1.png)
1818

19-
Go to the [Plugin homepage in the JetBrains Marketplace](https://plugins.jetbrains.com/plugin/26344-buggregator) and click the "Install" button.
20-
21-
To install the plugin from the IDE, go to IDEA settings → Plugins → Marketplace → Search for "Buggregator" → click "Install".
19+
## Installation
2220

2321
[![Downloads](https://img.shields.io/jetbrains/plugin/d/26344-buggregator?style=flat-square)](https://plugins.jetbrains.com/plugin/26344-buggregator)
2422
[![Rating](https://img.shields.io/jetbrains/plugin/r/rating/26344-buggregator?style=flat-square)](https://plugins.jetbrains.com/plugin/26344-buggregator/reviews)
2523
[![Version](https://img.shields.io/jetbrains/plugin/v/26344-buggregator?style=flat-square)](https://plugins.jetbrains.com/plugin/26344-buggregator/versions)
2624

27-
The IDE might ask you to restart it to apply the changes. After that, you can find the Buggregator button in the top right corner of the IDE window.
25+
### Marketplace
26+
27+
Go to the [Plugin homepage in the JetBrains Marketplace](https://plugins.jetbrains.com/plugin/26344-buggregator) and click the `Install` button.
28+
29+
### IDE Settings
30+
31+
To install the plugin from the IDE, go to IDEA settings → Plugins → Marketplace → Search for "Buggregator" → click `Install`.
32+
33+
> [!IMPORTANT]
34+
> The IDE might ask you to restart it to apply the changes. After that, you can find the Buggregator button in the top right corner of the IDE window.
35+
36+
## Overview
2837

2938
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.
3039

0 commit comments

Comments
 (0)