From 65654282a98cb0590d498e4ed9c924f97646f1dc Mon Sep 17 00:00:00 2001 From: Aylur Date: Wed, 25 Sep 2024 23:22:01 +0000 Subject: docs: restructure --- docs/libraries/notifd.md | 106 ----------------------------------------------- 1 file changed, 106 deletions(-) delete mode 100644 docs/libraries/notifd.md (limited to 'docs/libraries/notifd.md') diff --git a/docs/libraries/notifd.md b/docs/libraries/notifd.md deleted file mode 100644 index 7e02149..0000000 --- a/docs/libraries/notifd.md +++ /dev/null @@ -1,106 +0,0 @@ -# Notifd - -A [notification daemon](https://specifications.freedesktop.org/notification-spec/latest/) implementation as a library and CLI tool. - -## How it works - -The first instantiation of the [Notifd](https://aylur.github.io/libastal/notifd/class.Notifd.html) class will become the daemon and every subsequent instantiation will queue up to act as the daemon and will act as a client in the meantime. This means this library can be used throughout multiple processes. - -## Installation - -1. install dependencies - -:::code-group - -```sh [ Arch] -sudo pacman -Syu meson vala gdk-pixbuf2 json-glib gobject-introspection -``` - -```sh [ Fedora] -sudo dnf install meson gcc valac gdk-pixbuf2-devel json-glib-devel gobject-introspection-devel -``` - -```sh [ Ubuntu] -sudo apt install meson valac libgdk-pixbuf-2.0-dev libjson-glib-dev gobject-introspection -``` - -::: - -2. clone repo - -```sh -git clone https://github.com/aylur/astal.git -cd astal/lib/notifd -``` - -3. install - -```sh -meson setup build -meson install -C build -``` - -:::tip -Most distros recommend manual installs in `/usr/local`, -which is what `meson` defaults to. If you want to install to `/usr` -instead which most package managers do, set the `prefix` option: - -```sh -meson setup --prefix /usr build -``` - -::: - -## Usage - -You can browse the [Notifd reference](https://aylur.github.io/libastal/notifd). - -### CLI - -```sh -astal-notifd --help -``` - -### Library - -:::code-group - -```js [ JavaScript] -import Notifd from "gi://AstalNotifd" - -const notifd = Notifd.get_default() - -notifd.connect("notified", (_, id) => { - const n = notifd.get_notification(id) - print(n.summary, n.body) -}) -``` - -```py [ Python] -from gi.repository import AstalNotifd as Notifd - -notifd = Notifd.get_default() - -def on_notified(_, id): - n = notifd.get_notification(id) - print(n.get_body(), n.get_body()) - -notifd.connect("notified", on_notified) -``` - -```lua [ Lua] -local Notifd = require("lgi").require("AstalNotifd") - -local notifd = Notifd.get_default() - -notifd.on_notified = function(_, id) - local n = notifd.get_notification(id) - print(n.body, n.summary) -end -``` - -```vala [ Vala] -// Not yet documented -``` - -::: -- cgit v1.2.3