Permalink
Browse files

update readme with screencast and performance benchmarks

  • Loading branch information...
1 parent 35d5e1f commit 0d95bf7341db094bd4cf6c8e99fc6edbc19cab53 @egonSchiele committed Feb 5, 2014
Showing with 8 additions and 4 deletions.
  1. +8 −4 README.md
View
@@ -10,10 +10,6 @@ You can think of contracts as `assert` on steroids.
gem install contracts
-## Running Tests
-
- rspec spec/*.rb
-
## Hello World
A contract is one line of code that you write above a method definition. It validates the arguments to the method, and validates the return value of the method.
@@ -55,6 +51,14 @@ Instead of throwing an exception, you could log it, print a clean error message
Check out [this awesome tutorial](http://egonschiele.github.com/contracts.ruby).
+## Use Cases
+
+Check out [this screencast](https://vimeo.com/85883356).
+
+## Performance
+
+Using contracts.ruby results in very little slowdown. Check out [this blog post](http://adit.io/posts/2013-03-04-How-I-Made-My-Ruby-Project-10x-Faster.html#seconds-6) for more info.
+
**Q.** What Rubies can I use this with?
**A.** It's been tested with `1.8.7`, `1.9.2`, `1.9.3`, `2.0.0`, `2.1.0`, and `jruby` (both 1.8 and 1.9 modes).

0 comments on commit 0d95bf7

Please sign in to comment.