Doco; release 1.0.0.

technomancy · Mar 31, 2011 · 38226fb · 38226fb
1 parent fb651da
commit 38226fb
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -2,16 +2,27 @@
 
 Run only the test namespaces which failed last time around.
 
-## Usage
+## Single-project Usage
 
-You'll need to add a hook to project.clj:
+You'll need to add a :dev-dependency and a :hook to project.clj:
 
+    :dev-dependencies [[lein-retest "1.0.0"]]
     :hooks [leiningen.hooks.retest]
 
 Then each run of the tests will create a .lein-failures file in your
 project root recording which namespaces contained failures. Then
 running `lein retest` will re-run only those.
 
+## User-wide Usage
+
+    $ lein plugin install lein-retest 1.0.0
+
+Add this to ~/.lein/init.clj
+
+    (require 'leiningen.hooks.retest)
+
+Then you should be set to use it in all your projects.
+
 ## License
 
 Copyright (C) 2011 Phil Hagelberg

diff --git a/project.clj b/project.clj
@@ -1,3 +1,3 @@
-(defproject lein-retest "1.0.0-SNAPSHOT"
+(defproject lein-retest "1.0.0"
   :description "Run only the test namespaces which failed last time around."
   :eval-in-leiningen true)
diff --git a/src/leiningen/retest.clj b/src/leiningen/retest.clj
@@ -1,4 +1,5 @@
 (ns leiningen.retest
+  "Run only the test namespaces which failed last time around."
   (:require [leiningen.test]))
 
 (defn retest