summaryrefslogtreecommitdiff
path: root/README.md
blob: 3e52a1960389655e6228afdd5de5cc22bb0a83df (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# libnotify

## Description

libnotify is a library for sending desktop notifications to a notification
daemon, as defined in the [org.freedesktop.Notifications][fdo-spec] Desktop
Specification. These notifications can be used to inform the user about an event
or display some form of information without getting in the user's way.

It is also a simple wrapper to send cross-desktop Notifications for sandboxed
applications using the [XDG Portal Notification API][portal].

### Documentation

You can find the nightly documentation at https://gnome.pages.gitlab.gnome.org/libnotify/.

## Notice

For GLib based applications the [GNotification][gnotif] API should be used
instead.

[fdo-spec]: https://specifications.freedesktop.org/notification-spec/notification-spec-latest.html
[gnotif]: https://docs.gtk.org/gio/class.Notification.html
[portal]: https://github.com/flatpak/xdg-desktop-portal/blob/main/data/org.freedesktop.portal.Notification.xml