summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/default.nix6
-rw-r--r--docs/guide/libraries/greet.md94
-rw-r--r--docs/vitepress.config.ts1
3 files changed, 101 insertions, 0 deletions
diff --git a/docs/default.nix b/docs/default.nix
index ff7e8c9..3eae600 100644
--- a/docs/default.nix
+++ b/docs/default.nix
@@ -177,6 +177,12 @@ in
authors = "kotontrion";
}}
${genLib {
+ flakepkg = "greet";
+ gir = "Greet";
+ description = "IPC client for greetd";
+ version = ../lib/greet/version;
+ }}
+ ${genLib {
flakepkg = "hyprland";
gir = "Hyprland";
description = "IPC client for Hyprland";
diff --git a/docs/guide/libraries/greet.md b/docs/guide/libraries/greet.md
new file mode 100644
index 0000000..f0cd012
--- /dev/null
+++ b/docs/guide/libraries/greet.md
@@ -0,0 +1,94 @@
+# Greet
+
+Library and CLI tool for sending requests to [greetd](https://sr.ht/~kennylevinsen/greetd/).
+
+## Installation
+
+1. install dependencies
+
+:::code-group
+
+```sh [<i class="devicon-archlinux-plain"></i> Arch]
+sudo pacman -Syu meson vala json-glib gobject-introspection
+```
+
+```sh [<i class="devicon-fedora-plain"></i> Fedora]
+sudo dnf install meson vala valadoc json-glib-devel gobject-introspection-devel
+```
+
+```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
+sudo apt install meson valac libjson-glib-dev gobject-introspection
+```
+
+:::
+
+::: info
+Although `greetd` is not a direct build dependency,
+it should be self-explanatory that the daemon is required to be available at runtime.
+:::
+
+2. clone repo
+
+```sh
+git clone https://github.com/aylur/astal.git
+cd astal/lib/greet
+```
+
+3. install
+
+```sh
+meson setup --prefix /usr build
+meson install -C build
+```
+
+## Usage
+
+You can browse the [Greet reference](https://aylur.github.io/libastal/greet).
+
+### CLI
+
+```sh
+astal-greet --help
+```
+
+### Library
+
+:::code-group
+
+```js [<i class="devicon-javascript-plain"></i> JavaScript]
+import Greet from "gi://AstalGreet"
+
+Greet.login("username", "password", "compositor", (_, res) => {
+ try {
+ Greet.login_finish(res)
+ } catch (err) {
+ printerr(err)
+ }
+})
+```
+
+```py [<i class="devicon-python-plain"></i> Python]
+# Not yet documented
+
+```
+
+```lua [<i class="devicon-lua-plain"></i> Lua]
+local Greet = require("lgi").require("AstalGreet")
+
+Greet.login("username", "password", "compositor", function (_, res)
+ local err = Greet.login_finish(res)
+ if err ~= nil then
+ print(err)
+ end
+end)
+```
+
+```vala [<i class="devicon-vala-plain"></i> Vala]
+try {
+ yield AstalGreet.login("username", "password", "compositor");
+} catch (Error err) {
+ printerr(err.message);
+}
+```
+
+:::
diff --git a/docs/vitepress.config.ts b/docs/vitepress.config.ts
index f542a68..7e16eb7 100644
--- a/docs/vitepress.config.ts
+++ b/docs/vitepress.config.ts
@@ -105,6 +105,7 @@ export default defineConfig({
{ text: "Battery", link: "/guide/libraries/battery" },
{ text: "Bluetooth", link: "/guide/libraries/bluetooth" },
{ text: "Cava", link: "/guide/libraries/cava" },
+ { text: "Greet", link: "/guide/libraries/greet" },
{ text: "Hyprland", link: "/guide/libraries/hyprland" },
{ text: "Mpris", link: "/guide/libraries/mpris" },
{ text: "Network", link: "/guide/libraries/network" },