From 6cf6e96665bf647674644b486b23624fe88f8560 Mon Sep 17 00:00:00 2001 From: Cole Robinson Date: Wed, 3 May 2023 16:56:30 -0400 Subject: docs: Fix broken links in DBUS.md [skip ci] (#1145) --- docs/DBUS.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/DBUS.md b/docs/DBUS.md index ffbd61f4b..42ddcfd5b 100644 --- a/docs/DBUS.md +++ b/docs/DBUS.md @@ -8,13 +8,13 @@ This allows integrating Ferdium with your desktop environment by displaying the As an example integration, the [`docs/dbus`](dbus) folder contains a module for status bars written in Python. To run the example, you'll need Python 3.11 and the [`dbus-next`](https://pypi.org/project/dbus-next/) PyPI package. -The integration uses the [`FerdiumClient`](dbus/ferdium_client.py) client library, which is an asynchronous wrapper over the D-Bus interface. +The integration uses the [`ferdium-dbus-py`](https://github.com/victorbnl/ferdium-dbus-py) client library, which is an asynchronous wrapper over the D-Bus interface. It illustrates multiple advanced concepts, such as asynchronous communication with Ferdium via `asyncio` and polling the session D-Bus to see if Ferdium is running. The [`ferdium_bar.py`](dbus/ferdium_bar.py) implements a bar module to use with status bars such as waybar or polybar. See `ferdium_bar.py --help` and `ferdium_bar.py unread --help` for further indications on how to use it. ## Low-level API -The low-level API exposed over D-Bus is documented in [`org.ferdium.Ferdium.xml](docs/org.ferdium.Ferdium.xml) with standard D-Bus introspection syntax. +The low-level API exposed over D-Bus is documented in [`org.ferdium.Ferdium.xml`](dbus/org.ferdium.Ferdium.xml) with standard D-Bus introspection syntax. Ferdium will take ownership of the bus name `org.ferdium.Ferdium` and expose and object implementing the `org.ferdium.Ferdium` interface at the object path `/org/ferdium`. -- cgit v1.2.3-70-g09d2