Add README

1 files changed, 19 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2a45f5b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+clipnotify is a simple program that, using the
+[XFIXES](https://cgit.freedesktop.org/xorg/proto/fixesproto/plain/fixesproto.txt)
+extension to X11, waits until a new selection is available and then exits.
+
+It was primarily designed for [clipmenu](https://github.com/cdown/clipmenu), to
+avoid polling for new selections.
+
+Here's how it's intended to be used:
+
+    while true; do
+        clipnotify  # When clipnotify exists, a new selection event was detected.
+        [do something with the selection]
+    done
+
+clipnotify doesn't try to print anything about the contents of the selection,
+it just exists when it changes. This is intentional -- X11's selection API is
+verging on the insane, and there are plenty of others who have already lost
+their sanity to bring us xclip/xsel/etc. Use one of those tools to complement
+clipnotify.