add quick readmemain

1 files changed, 9 insertions, 0 deletions

diff --git a/readme.mkd b/readme.mkd
new file mode 100644
index 0000000..bca4874
--- /dev/null
+++ b/readme.mkd
@@ -0,0 +1,9 @@
+# fakjs for your javascript stubbing needs.
+
+To fake out a return value.
+
+```javascript
+  var fake = new Fake();
+  fake.stub('greet').with('mo').andReturn('hello mo');
+  expect(fake.greet('mo')).toEqual('hello mo');
+```