diff options
author | Cole Robinson <crobinso@redhat.com> | 2023-05-03 16:56:30 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-05-03 21:56:30 +0100 |
commit | 6cf6e96665bf647674644b486b23624fe88f8560 (patch) | |
tree | b7de54e01ac045580a1f9c34fb9e8fd4886066fe /docs | |
parent | 6.2.7-nightly.10 [skip ci] (diff) | |
download | ferdium-app-6cf6e96665bf647674644b486b23624fe88f8560.tar.gz ferdium-app-6cf6e96665bf647674644b486b23624fe88f8560.tar.zst ferdium-app-6cf6e96665bf647674644b486b23624fe88f8560.zip |
docs: Fix broken links in DBUS.md [skip ci] (#1145)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/DBUS.md | 4 |
1 files 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 | |||
8 | As an example integration, the [`docs/dbus`](dbus) folder contains a module for status bars written in Python. | 8 | As an example integration, the [`docs/dbus`](dbus) folder contains a module for status bars written in Python. |
9 | To run the example, you'll need Python 3.11 and the [`dbus-next`](https://pypi.org/project/dbus-next/) PyPI package. | 9 | To run the example, you'll need Python 3.11 and the [`dbus-next`](https://pypi.org/project/dbus-next/) PyPI package. |
10 | 10 | ||
11 | The integration uses the [`FerdiumClient`](dbus/ferdium_client.py) client library, which is an asynchronous wrapper over the D-Bus interface. | 11 | 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. |
12 | 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. | 12 | 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. |
13 | 13 | ||
14 | 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. | 14 | 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. |
15 | 15 | ||
16 | ## Low-level API | 16 | ## Low-level API |
17 | 17 | ||
18 | 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. | 18 | 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. |
19 | 19 | ||
20 | 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`. | 20 | 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`. |