add basic readme

kevinburke · Jun 1, 2015 · b1babe6 · b1babe6
1 parent 282eb3e
commit b1babe6
Showing 1 changed file with 26 additions and 0 deletions.
diff --git a/readme.markdown b/readme.markdown
@@ -0,0 +1,26 @@
+# Lucifer
+
+This is a tool that will help you reload your Javascript based test suite
+really fast.
+
+### Usage
+
+```
+The Lucifer binary makes requests to the Lucifer server.
+
+Usage:
+
+    lucifer command [arguments]
+
+The commands are:
+
+    invalidate      Invalidate the cache for a given file
+    run             Run tests for a given file
+
+Use "lucifer help [command]" for more information about a command.
+```
+
+### Install
+
+Run `make install`. You'll want to have Go installed to install the command
+line client.