Skip to content

Commit

Permalink
Edit README
Browse files Browse the repository at this point in the history
  • Loading branch information
GamePad64 committed Dec 9, 2024
1 parent ccfe79a commit 32c7a4c
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 16 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ members = [
"transports/notifico-slack",
"transports/notifico-pushover",
"transports/notifico-gotify",
"transports/notifico-ntfy",
"notifico-template",
"notifico-template/migration",
"notifico-worker",
Expand All @@ -23,7 +24,6 @@ members = [
"notifico-ingest",
"notificox",
"notifico-transports",
"transports/notifico-ntfy",
]

[workspace.dependencies]
Expand Down
33 changes: 18 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ configuration instructions.
The documentation includes guides on setting up the server, configuring different transports, and managing
notifications effectively.

## Notificox

**Notificox** (*Notifico eXecute*) is a command-line tool for interacting with Notifico and running notification pipelines locally or using remote
Notifico instance.
It is designed to be small and self-contained. It can be used to send notifications, using simple URL-like credentials to popular services.

## 🎯 Roadmap:

- [x] Admin panel
Expand All @@ -36,18 +42,15 @@ notifications effectively.
- [ ] Auto-retry for sending failed messages
- [ ] Template and Pipeline versioning

## 🚆 Transports:

- [x] SMTP (email)
- [x] SMPP (SMS)
- [x] Slack
- [x] Telegram
- [x] WhatsApp Business
- [x] Pushover
- [x] Gotify
- [x] Ntfy
- [ ] Apprise API
- [ ] Microsoft Teams
- [ ] Discord
- [ ] Mattermost
- [ ] Twilio
## 🚆 Available Transports:

| Transport | Transport ID |
|----------------------------------------------------------|--------------|
| [SMTP (email)](https://notifico.tech/plugins/smtp/) | smtp |
| [SMPP (SMS)](https://notifico.tech/plugins/smpp/) | smpp |
| [Gotify](https://notifico.tech/plugins/gotify/) | gotify |
| [Ntfy](https://notifico.tech/plugins/ntfy/) | ntfy |
| [Pushover](https://notifico.tech/plugins/pushover/) | pushover |
| [Slack](https://notifico.tech/plugins/slack/) | slack |
| [Telegram](https://notifico.tech/plugins/telegram/) | telegram |
| [WhatsApp Business](https://notifico.tech/plugins/waba/) | waba |

0 comments on commit 32c7a4c

Please sign in to comment.