Stefan Saasen avatar Stefan Saasen committed 52bebd7

Update README to include Linux support and to update the JSON output format

Comments (0)

Files changed (1)

 Spy
 ===
 
-Spy is a compact file system watcher for Mac OS X using the [File System Events API](https://developer.apple.com/library/mac/#documentation/Darwin/Conceptual/FSEvents_ProgGuide/Introduction/Introduction.html) via [hfsevents](https://github.com/luite/hfsevents).
+Spy is a compact file system watcher for Mac OS X and Linux (Note: Should work on Windows but is currently untested).
 
 
 Usage
 The default format is the full path to the modified file followed by a newline. To make it easier to parse the output, the `--format=json` changes the output to be printed formatted as a JSON object (again followed by a newline).
 
     $> spy watch --format=json .
-    {"path": "path/to/modified/file", "flags": ["ItemModified"], "id": 123143234}
+    {"path":"/path/to/modified.file","time":"2012-12-20 11:16:03.363614 UTC"}
 
 For directories the following options apply:
 
 Installation
 ============
 
-Spy only works on Mac OS X >= 10.7 (Lion and above)!
-
 Binary distribution
 -------------------
 
-The binary distribution contains a 64bit binary compiled for Mac OS X > 10.7.
+The binary distribution contains a 64bit binary compiled for Mac OS X or Linux.
 
-Download the tarball and run "make install" to copy the binary and the man page into the correct target directories:
+Download the tarball from https://bitbucket.org/ssaasen/spy/downloads and run "make install" to copy the binary and the man page into the correct target directories:
 
-    $> curl -OL https://bitbucket.org/ssaasen/spy/downloads/spy-osx-x86_64-v0.4.tar.gz
-    $> tar xfz spy-osx-x86_64-v0.4.tar.gz
+    $> curl -OL https://bitbucket.org/ssaasen/spy/downloads/spy-PLATFORM-ARCH-VERSION.tar.gz
+    $> tar xfz spy-PLATFORM-ARCH-VERSION.tar.gz
     $> cd spy
     $> make install
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.