Skip to content

Commit 368bb0d

Browse files
committed
readme update
1 parent fba8823 commit 368bb0d

1 file changed

Lines changed: 35 additions & 3 deletions

File tree

README.md

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,51 @@
11
# bunny-pack
22

3-
A Firefox add-on to improve the RabbitMQ web interface a little.
3+
A browser extension to improve the RabbitMQ web interface a little.
44

55
## Features
66

77
- MessagePack message decoding
88
- Easy "Copy message" button
9-
- JSON message pretty formating
9+
- JSON message pretty formatting
1010
- Dark mode
1111

1212
## Install
1313

14-
- Download the [latest](https://github.com/nbr23/bunny-pack/releases/latest) release's `.xpi` file.
14+
### Firefox
15+
16+
- Download the [latest](https://github.com/nbr23/bunny-pack/releases/latest) release's `.xpi` file
1517
- Add it to Firefox (Go to `about:addons`, then `Install Add-On From File...`)
1618
- Once installed, you may need to activate it for specific domains:
1719
- Browse to your RabbitMQ web interface
1820
- Hit the `Extensions` puzzle icon in your tool bar
1921
- Click BunnyPack's setting, and `Always Allow on ...`
22+
23+
### Chrome
24+
25+
- Download the [latest](https://github.com/nbr23/bunny-pack/releases/latest) release's `*-chrome.zip` file
26+
- Extract the zip file to a folder on your computer
27+
- Open Chrome and navigate to `chrome://extensions/`
28+
- Enable "Developer mode" by toggling the switch in the top-right corner
29+
- Click the "Load unpacked" button
30+
- Select the folder where you extracted the extension files
31+
32+
## Configuration
33+
34+
After installation, you can access the extension settings to enable/disable dark mode:
35+
36+
- **Firefox**: Click the extension icon or go to `about:addons` and click Options for BunnyPack
37+
- **Chrome**: Click the extension icon or right-click and select "Options"
38+
39+
## Building from Source
40+
41+
If you prefer to build the extension yourself:
42+
43+
```bash
44+
# Build for both browsers
45+
make all
46+
47+
# Clean build artifacts
48+
make clean
49+
```
50+
51+
The built extensions will be in `./web-ext-artifacts/`

0 commit comments

Comments
 (0)