Skip to content

Commit b99684c

Browse files
committed
Readme: add get started and header
(cherry picked from commit b8ad35b)
1 parent d33766a commit b99684c

File tree

3 files changed

+44
-1
lines changed

3 files changed

+44
-1
lines changed

.editorconfig

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
end_of_line = lf
6+
insert_final_newline = true
7+
indent_style = space
8+
indent_size = 4
9+
trim_trailing_whitespace = true
10+
11+
[*.md]
12+
trim_trailing_whitespace = false
13+
14+
[*.yml]
15+
indent_style = space
16+
indent_size = 2
17+
18+
[*.json]
19+
indent_style = space
20+
indent_size = 4

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,30 @@
1-
# Buggregator IDEA Plugin
1+
<h1 align="center">Buggregator IDEA Plugin</h1>
22

3+
<div align="center">
4+
5+
[![Twitter](https://img.shields.io/badge/-Follow-black?style=flat-square&logo=X)](https://twitter.com/buggregator)
6+
[![Discord](https://img.shields.io/static/v1?style=flat-square&label=Join&message=Discord&logo=Discord&color=%235865F2)](https://discord.gg/qF3HpXhMEP)
7+
[![Support](https://img.shields.io/static/v1?style=flat-square&label=Support&message=%E2%9D%A4&logo=GitHub&color=%23fe0086)](https://boosty.to/xepozz/single-payment/donation/669411/target)
8+
9+
</div>
10+
11+
The plugin integrates Buggregator into the JetBrains IDEs, allowing you to debug your code with ease.
12+
Now you don't need to switch to another window or screen to look at dumps and then back to run tests.
13+
Everything is in front of you, and all the shortcuts work.
14+
15+
![img.png](resources/img_1.png)
16+
17+
## Get started
18+
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".
322

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

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.
28+
29+
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.
30+

resources/img_1.png

440 KB
Loading

0 commit comments

Comments
 (0)