chore: rework plugin readmes, json changelogs and standalone repo setup

2026-10-30 07:05:24 +00:00 · 2026-10-04 21:25:16 -05:00
1 parent a8f383d2b3
commit 29a946d02e
@@ -1,39 +1,39 @@
-# Alerts
+<div align="center">

-One inbox for every alert, with delivery to webhooks, ntfy, Discord and email.
+<img src="https://raw.githubusercontent.com/Termix-SSH/Termix/main/public/icon.svg" width="120" height="120" alt="Termix Logo" />
+
+<h1>Alerts</h1>
+
+<p>One inbox for every alert in Termix</p>
+
+</div>
+
+<br />
+
+## Overview
+
+Alerts is the inbox every Termix alert lands in, with delivery to Discord, ntfy, email or a webhook.
+
+<br />

 ## Features

- One inbox for alerts from every part of Termix.
- Popups for new alerts, filtered by severity.
- Channels that send alerts to webhooks, ntfy, Discord and email.
- Delivery rules that pick which alerts go to which channel.
- Optional news from the Termix team, like security notices and new releases.
+- One inbox for alerts from every part of Termix
+- Popups for new alerts
+- Send alerts to Discord, ntfy, email or a webhook
+- Rules that pick which alerts go where
+- Optional news from the Termix team, like security notices and releases

-## Settings
+<br />

-### Admin
+## Support

- Termix announcements: show news from the Termix team in everyone's inbox.
- Keep alerts for (days): older alerts are removed from every inbox.
- SMTP server, port, TLS, username, password and from address: needed for email channels. Leave the server empty to turn email off.
+To report a bug or request a feature, open a [support ticket](https://github.com/Termix-SSH/Support/issues/new/choose). You need to be logged in to GitHub. Please be as detailed as possible, preferably in English.

-### User
+For discussions and questions, join the [Discord](https://discord.gg/jVQGdvHDrf) server.

- Alert popups: all alerts, warnings and critical, critical only, or none.
+<br />

-## Permissions
+## License

- `alerts.use`: Get alerts in the inbox and send them to your own channels. Admins and users have it by default.
-
-## For plugin authors
-
-Send an alert from any plugin with `ctx.notify.send()`. This plugin stores it and delivers it. Do not build a separate notification system into a plugin.
-
-## Development
-
-```bash
-npm run build      # build into dist/
-npm run test       # run this plugin's tests
-npm run typecheck  # type-check this plugin
-```
+Distributed under the Apache License Version 2.0. See [LICENSE](https://github.com/Termix-SSH/Termix/blob/main/LICENSE) for more information.