Move to README.md.

technomancy · Jul 4, 2012 · f1ae186 · f1ae186
1 parent 6715685
commit f1ae186
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 20 deletions.
diff --git a/README b/README
diff --git a/README.md b/README.md
@@ -0,0 +1,24 @@
+# lein-play
+
+Play sounds when your tests pass or fail.
+
+## Installation
+
+Add this to `:plugins` in your `:user` profile in `~/.lein/profiles.clj`:
+
+    [lein-play "2.0.0-SNAPSHOT"]
+
+And this to the `:hooks` entry:
+
+    `leiningen.hooks.play`
+
+Place a leiningen/(pass|fail).mp3 in `~/.lein` to override the
+built-in sounds.
+
+## License
+
+Copyright © 2010, 2012 Phil Hagelberg
+
+The code is licensed under the Eclipse Public License. The sound
+effects are licensed under Creative Commons Attribution Sharealike
+license.