Permalink
Browse files

Update README

  • Loading branch information...
1 parent 7964ccc commit 3c057f97090e06c5d37500a262b2fa3e59acd643 @ggreer committed Apr 21, 2012
Showing with 14 additions and 4 deletions.
  1. +14 −4 README.md
View
@@ -1,8 +1,18 @@
# FSEvents Tools
-Like inotify-tools, but for OS X. This code is nowhere close to usable.
+Command-line tools and scripts that use OS X's [FSEvents](http://en.wikipedia.org/wiki/FSEvents) API.
-## See also
+## Usage examples
-inotify-tools
-lsyncd
+Alert if any files in a directory are changed.
+
+ notifywait /path/; echo "\007"
+
+Automatically rsync files to a remote server if any of them are changed.
+
+ notify_loop ~/code/directory rsync -avz --exclude="*.pyc" ~/code/directory/ server.example.com:/stuff/
+
+## Related software
+
+* [inotify-tools](https://github.com/rvoicilas/inotify-tools)
+* [Lsyncd](https://github.com/axkibe/lsyncd)

0 comments on commit 3c057f9

Please sign in to comment.