From: Manish Khettry <manish@ooyala.com>
Date: Sun, 22 Apr 2012 23:11:04 +0000 (-0700)
Subject: better readme
X-Git-Url: https://git.brokenzipper.com/gitweb?a=commitdiff_plain;h=f8afbaf50121388791e5eb39cf70aa7971dce177;p=chaz%2Fsbt-tap

better readme
---

diff --git a/README b/README
deleted file mode 100644
index ebed61e..0000000
--- a/README
+++ /dev/null
@@ -1 +0,0 @@
-Sbt plugin to generate results in tap format. 
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..8d68423
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,21 @@
+Provides reporting of test success and failure for tests run by
+[simple build tool](https://github.com/harrah/xsbt)
+in a [TAP](http://en.wikipedia.org/wiki/Test_Anything_Protocol)format
+
+All the test results will be generated in one file: test-results/test.tap
+
+To use
+
+1. Add this plugin to your sbt project. Create project/project/Plugins.scala that looks like this:
+
+        import sbt._
+        // sets up other project dependencies when building our root project
+        object Plugins extends Build {
+          lazy val root = Project("root", file(".")) dependsOn(tapListener)
+          lazy val tapListener = RootProject(uri("git://github.com/mkhettry/sbt-tap.git"))
+        }
+
+2. In your build.sbt, add the SbtTapListener to the sequence of Test Listeners.
+
+        testListeners += SbtTapReporting.tapListener
+