summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarco Trevisan (Treviño) <mail@3v1n0.net>2022-04-21 18:51:13 +0200
committerMarco Trevisan (Treviño) <mail@3v1n0.net>2022-04-21 18:51:13 +0200
commit2accd4ceab25015b36d160b21b89d69ef0acb3f2 (patch)
tree84064a3ba7fdeee08277fae62fbf6e34338c7786
parent333f7c5d32aad09b859b39268f43a0fbbd6ec8cf (diff)
downloadlibnotify-2accd4ceab25015b36d160b21b89d69ef0acb3f2.tar.gz
Revert "Revert "Merge branch 'readme' into 'master'""
This reverts commit 1ad46301071856663735812a4dd7c15e6f054fd4. As per: https://gitlab.gnome.org/GNOME/libnotify/-/commit/1ad46301#note_1434358
-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