From 4e280967d228d0b85656133e40d64b714f9500f7 Mon Sep 17 00:00:00 2001
From: Albert S <mail@quitesimple.org>
Date: Sun, 19 Mar 2017 10:42:12 +0100
Subject: [PATCH] add README.md

---
 README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6e398f8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+What is adhocify?
+=================
+adhocify uses inotify to watch for file system events. Once an event 
+occurs it can execute a script. The path of the file and the event 
+will be passed to that script. 
+
+Requirements
+============
+adhocify only runs on Linux. You need a kernel and libc with inotify 
+support - pretty much all satisfy this condition.
+
+Options
+=======
+See adhocify --help.
+
+Examples:
+=========
+adhocify -w /tmp/ /home/user/myscript.sh
+	 * Watches for IN\_CLOSE\_WRITE events in /tmp/ and  launches script /home/user/myscript.sh
+
+adhocify -w /tmp/ /home/user/myscript.sh {}
+	* Same as above, but also passes the file an event occured on to that script.(argv[1]).
+
+
+adhocify -w /tmp/ /bin/echo the file {} was written to
+	* Running echo "Test" > /tmp/test will print in the shell adhocify was launched in: "the file /tmp/test was written to"
+
+adhocify -w /tmp/ -w /var/run /home/user/myscript.sh
+	* Same as above, but also watches /var/run
+
+adhocify /home/user/myscript.sh
+	* Watches for IN\_CLOSE\_WRITE events in the current directory, launches script 
+	/home/user/myscript.
+
+adhocify -m IN\_OPEN -w /tmp /home/user/myscript.sh
+	* Watches for IN\_OPEN events in /tmp/, launches script /home/user/myscript.sh
+
+adhocify -w /tmp -i *.txt /home/user/myscript.sh
+	* Watches for IN\_CLOSE\_WRITE events in /tmp/ but will not pass *.txt files to the script
+
+