From cc27842fa9eb9cd8b418f9c0111d50ec896dee95 Mon Sep 17 00:00:00 2001
From: Spencer Florence <florence@ccs.neu.edu>
Date: Sun, 28 Dec 2014 16:04:44 -0600
Subject: [PATCH] added README

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..81f955f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# Better Test
+
+This library is a replacement for rackets `raco test` that has a few benefits. Namely, it can generate code coverage reports and it will return with a non-zero exit code if tests fail.
+
+## How to install
+
+install via `raco pkg install better-test`. To install for development, checkout the repo into a folder named `Better Test` and in the parent directory run `raco pkg install better-test/`.
+
+## How to use
+
+To view the arguments for Better Test run `raco better-test -h`.
+
+Code coverage can be generated by specifying the `-c <format>` flag.
+Right now the valid formats are: html. Coveralls support is comming.
+The directory that the coverage is outputted to can be specified with the `-d` flag.
+
+If any tests run by `rackunit` fail, Better Test will return with exit code `1`. If all tests pass it will return with exit code `0`.
+
+
+## Internals
+
+Better Test also comes with a racket API for running tests and generating coverage reports. Documentation comming soon...