Skip to content

Commit bec0ac9

Browse files
authored
Revise README for better clarity and organization
Updated README to improve clarity and structure, including installation instructions and feature descriptions.
1 parent 03e7ac3 commit bec0ac9

1 file changed

Lines changed: 36 additions & 33 deletions

File tree

README.md

Lines changed: 36 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -2,76 +2,79 @@
22

33
![Slactac Logo](https://raw.githubusercontent.com/dotMavriQ/Slactac/refs/heads/master/icons/icon128.png)
44

5-
**Slactac** is a browser extension that lets you persistently override and customize Slack channel names. Personalize your workspace by renaming channels to something more meaningful or easier to recognize. *(Note: user renaming is not supported yet.)*
5+
### Supported for your Browser of choice
66

7-
**Now available for Chrome, Edge, Brave, and Firefox!**
7+
| Browser | Availability |
8+
|--------|--------------|
9+
| **Firefox** | **Available now on Firefox Add-ons** |
10+
| **Chrome / Edge / Brave** | **Available now on the Chrome Web Store** |
811

912
---
1013

11-
## Installation
14+
## 🔧 Installation Links
1215

13-
### Chrome Web Store (Chrome, Edge, Brave)
16+
- **Firefox:**
17+
[Slactac on Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/slactac/)
1418

15-
Install directly from the Chrome Web Store:
19+
- **Chrome / Edge / Brave:**
20+
[Slactac on Chrome Web Store](https://chromewebstore.google.com/detail/slactac/gnjiocbockjlkpnlonimgihcbhpdephe)
1621

17-
[https://chromewebstore.google.com/detail/slactac/gnjiocbockjlkpnlonimgihcbhpdephe](https://chromewebstore.google.com/detail/slactac/gnjiocbockjlkpnlonimgihcbhpdephe)
18-
19-
If you find **Slactac** useful, please consider leaving a rating or short review. Any feedback helps support development and improves the extension for everyone. Obrigado!
22+
---
2023

21-
### Firefox
24+
# Slactac
2225

23-
Download the Firefox release from [GitHub Releases](https://github.com/dotMavriQ/Slactac/releases):
26+
**Slactac** is a browser extension that lets you persistently override and customize Slack channel names. Personalize your workspace by renaming channels to something more meaningful or easier to recognize. *(Note: user renaming is not supported yet.)*
2427

25-
1. Download `slactac_firefox-vX.X.X.zip` from the latest Firefox release
26-
2. Extract the ZIP file
27-
3. Open Firefox and go to `about:debugging#/runtime/this-firefox`
28-
4. Click **Load Temporary Add-on**
29-
5. Select the `manifest.json` from the extracted folder
28+
**Now available for Chrome, Edge, Brave, and Firefox!**
3029

3130
---
3231

3332
## Features
3433

3534
- Override Slack channel names.
3635
- Use the channel picker to grab channel names directly from the Slack UI.
37-
- Save, view, and manage custom channel names via a polished popup interface.
36+
- Save, view, and manage custom channel names via a clean popup interface.
3837
- Real-time updates on the Slack web app with persistent overrides across sessions.
3938

40-
### Manual Installation (Chrome, Edge, Brave)
39+
---
40+
41+
## Manual Installation (Chrome, Edge, Brave)
4142

4243
1. Clone or download this repository.
43-
2. Open Chrome, Edge, or Brave and browse to the extensions page:
44+
2. Open Chrome, Edge, or Brave and go to:
4445
- Chrome: `chrome://extensions/`
4546
- Edge: `edge://extensions/`
4647
- Brave: `brave://extensions/`
47-
3. Enable **Developer Mode** in the top-right corner.
48+
3. Enable **Developer Mode**.
4849
4. Click **Load unpacked** and select the `slactac` folder.
4950

50-
**Note:** Edge and Brave may ask you to review the requested permissions (`tabs`, `activeTab`, and `storage`). These are required for the channel picker and for updating the active Slack tab reliably. If you do not see your Slack workspace update immediately, ensure the Slack tab is focused and refreshed once after installing the extension.
51-
52-
## Installation (Manual)
51+
---
5352

5453
## Releases
5554

56-
Every push to the `master` and `firefox` branches triggers automated builds:
55+
Pushes to `master` and `firefox` generate release ZIPs:
5756

58-
- **Chrome/Edge/Brave**: Tagged releases on `master` branch create `slactac_chrome-vX.X.X.zip`
59-
- **Firefox**: Tagged releases on `firefox` branch create `slactac_firefox-vX.X.X.zip` (auto-bumped +0.0.1)
57+
- **Chrome/Edge/Brave:** `slactac_chrome-vX.X.X.zip`
58+
- **Firefox:** `slactac_firefox-vX.X.X.zip`
6059

61-
Both are available as GitHub release assets. Download the appropriate ZIP for your browser or submit to the respective store catalogues.
60+
Both are available on GitHub Releases.
61+
62+
---
6263

6364
## Usage
6465

65-
1. Click the **Slactac** icon in your browser toolbar to open the popup.
66-
2. Use the **Pick Channel** button or manually enter the **Original Slack Channel Name**.
67-
3. Enter your desired custom channel name in the **Your Custom Channel Name** field.
68-
4. Click **Save Tack** to apply the override—the Slack channel name will update in real time.
69-
5. To view or delete stored overrides, click the **Stored Tacks** button.
66+
1. Click the **Slactac** icon.
67+
2. Pick a channel or enter the original name manually.
68+
3. Add your custom name.
69+
4. Hit **Save Tack**.
70+
5. Manage saved overrides via **Stored Tacks**.
71+
72+
---
7073

7174
## Contributing
7275

73-
Contributions are welcome! Feel free to submit issues or pull requests for new features, bug fixes, or improvements.
76+
PRs and issues welcome.
7477

7578
## License
7679

77-
This project is licensed under the MIT License.
80+
MIT

0 commit comments

Comments
 (0)