First commit

1 files changed, 23 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..12bcfad
--- /dev/null
+++ b/README
@@ -0,0 +1,23 @@
+OSX Jiggler
+===========
+
+Prevents sleeping by simulating cursor movement. Useful in enterprisy
+environments where sleep settings are org managed.
+
+Installation
+============
+
+1. Clone or download the source code
+
+2. Run 'make' to compile the program
+
+3. Run 'sudo make install' to install the binary to '/usr/local/bin'
+or 'make install PREFIX=/custom/path' if you want to install in a
+different location.
+
+4. Run 'osx-jiggler'
+
+5. Optionally, to autostart 'osx-jiggler' you can copy the included
+launch agent and start it right away by running:
+  cp dist/com.osx_jiggler.plist ~/Library/LaunchAgents/ && \
+  launchctl load ~/Library/LaunchAgents/com.osx_jiggler.plist 
\ No newline at end of file