Better README.

highfidelity · Oct 24, 2011 · 62feac8 · 62feac8
1 parent e54e98d
commit 62feac8
Showing 1 changed file with 13 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -3,4 +3,16 @@
 Currently in alpha. Needs complete test coverage, then more functionality can
 be added.
 
-Call FakeBraintree.activate! to make it go.
+## Quick start
+Call `FakeBraintree.activate!` to make it go. `FakeBraintree.clear!` will clear
+all data, which you probably want to do before each test.
+
+Example, in spec\_helper.rb:
+
+    FakeBraintree.activate!
+
+    RSpec.configure do |c|
+      c.before do
+        FakeBraintree.clear!
+      end
+    end