summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMaximiliano Sandoval R <msandova@gnome.org>2022-03-14 17:50:55 +0100
committerMaximiliano Sandoval R <msandova@gnome.org>2022-03-14 17:50:55 +0100
commitedb1dc8394e4543d7918ae6b518f0599eada7de4 (patch)
tree75af3868c3d8590059a9833b6ae3a36275264a62
parenta228f1e84d8a1ebe2a2cc10d19900af719ed44dc (diff)
downloadlibnotify-edb1dc8394e4543d7918ae6b518f0599eada7de4.tar.gz
Add README clarifying status of libnotify
See discussions at https://gitlab.gnome.org/GNOME/libnotify/-/issues/20. Based off https://gitlab.gnome.org/GNOME/libnotify/-/merge_requests/19
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f9ebf9e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# 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.
+
+## 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