commit 6f1b8435da99013ab55f7e543b76347bf534c51d
parent c402841c15beb33fcfcc73601824ef2b56f2d666
Author: JayVii <jayvii[AT]posteo[DOT]de>
Date: Sat, 29 Jun 2024 21:37:00 +0200
feat: transform readme to markdown
Diffstat:
1 file changed, 12 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
@@ -6,9 +6,11 @@ It checks your current IM messages via several CLI clients for different
platform and notifies you about potential messages.
Currently supported:
+
- Telegram via [`telegram-cli`](https://github.com/vysheng/tg)
Future work (WIP, currently not implemented):
+
- Matrix via [`matrix-commander`](https://github.com/8go/matrix-commander)
- Signal via [`signal-cli`](https://github.com/AsamK/signal-cli)
@@ -30,7 +32,8 @@ Sending Notifications: `gdbus` (likely installed already)
### Telegram
Checking Telegram Messages: [`telegram-cli`](https://github.com/vysheng/tg)
-```
+
+```bash
# Debian
apt install telegram-cli
@@ -39,14 +42,16 @@ apk add tg
```
Set it up via commandline:
-```
+
+```bash
telegram-cli
```
## Install IM Notifier
Pull this source directory, and run `debuild`:
-```
+
+```bash
git pull https://src.jayvii.de/pub/notifier.git
cd Notifier
debuild
@@ -54,7 +59,8 @@ debuild
This will create a Debian installation package `.deb`, which you may install
via:
-```
+
+```bash
sudo apt install ../im-notifier_*.deb
```
@@ -69,7 +75,8 @@ you can also install via `apt`, just like above.
Installing IM-Notifier also creates an App-Icon in your application menu.
Opening this application will run the daemon in the background. You can start
this notifier automatically upon login:
-```
+
+```bash
mkdir -p ~/.config/autostart
cp /usr/share/applications/im-notifier.desktop ~/.config/autostart/
```