commit 25bca72d21ba951a90f5bca3130783e964edc288
parent ad091c413c3c8b0fa284397917f7fa0c9ace3e8d
Author: JayVii <jayvii[AT]posteo[DOT]de>
Date: Sun, 19 Sep 2021 17:01:04 +0200
Testing HTML README
Diffstat:
1 file changed, 34 insertions(+), 0 deletions(-)
diff --git a/README.html b/README.html
@@ -0,0 +1,34 @@
+<h1 id="instant-message-notifier">Instant Message Notifier</h1>
+<h2 id="what-does-it-do">What does it do?</h2>
+<p>It checks your current IM messages via several CLI clients for different platform and notifies you about potential messages.</p>
+<p>Currently supported: - Telegram via <a href="https://github.com/vysheng/tg"><code>telegram-cli</code></a></p>
+<p>Future work (WIP, currently not implemented): - Matrix via <a href="https://github.com/8go/matrix-commander"><code>matrix-commander</code></a> - Signal via <a href="https://github.com/AsamK/signal-cli"><code>signal-cli</code></a></p>
+<h2 id="why">Why?</h2>
+<p>Many IM clients, such as the Telegram Desktop client or the Signal Desktop client are somewhat resource intensive, particularly on the CPU, leading to high(er) power consumption. With this lightweight notifier script, you are not required to have the desktop client running in the background at all times.</p>
+<h2 id="are-there-system-requirements">Are there system requirements?</h2>
+<p>Yes.</p>
+<h3 id="common">Common</h3>
+<p>Sending Notifications: <code>gdbus</code> (likely installed already)</p>
+<h3 id="telegram">Telegram</h3>
+<p>Checking Telegram Messages: <a href="https://github.com/vysheng/tg"><code>telegram-cli</code></a></p>
+<pre><code># Debian
+apt install telegram-cli
+
+# PostmarketOS
+apk add tg</code></pre>
+<p>Set it up via commandline:</p>
+<pre><code>telegram-cli</code></pre>
+<h2 id="install-im-notifier">Install IM Notifier</h2>
+<p>Pull this source directory, and run <code>debuild</code>:</p>
+<pre><code>git pull https://src.jayvii.de/PinePhone/Notifier
+cd Notifier
+debuild</code></pre>
+<p>This will create a Debian installation package <code>.deb</code>, which you may install via:</p>
+<pre><code>sudo apt install ../im-notifier_*.deb</code></pre>
+<p>Packages are being built automatically by Gitlab-CI: https://gitlab.com/jayvii_de/pp-notifier/-/jobs</p>
+<p>You can Download the “artifacts”, which contain the latest <code>.deb</code> version, that you can also install via <code>apt</code>, just like above.</p>
+<h2 id="use-im-notifier">Use IM Notifier</h2>
+<p>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:</p>
+<pre><code>mkdir -p ~/.config/autostart
+cp /usr/share/applications/im-notifier.desktop ~/.config/autostart/</code></pre>
+<p>IM Notifier reads configurations from <code>~/.config/im-notifier/config</code>. A sample file can be found in the root repository as <a href="./config.sample"><code>config.sample</code></a></p>
