Gives some indication of how to use the gem

jonathonjones · Feb 29, 2012 · 6765911 · 6765911
1 parent a469d09
commit 6765911
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/Readme.md b/Readme.md
@@ -4,6 +4,18 @@ Mutant is a mutation tester. It modifies your code and runs your tests to make s
 
 Largely based on [heckle](https://github.com/seattlerb/heckle), this is a rewrite on top of [Rubinius](http://rubini.us).
 
+## Usage
+
+````
+mutate "ClassName#method_to_test" spec
+````
+
+To test a class method, use:
+
+````
+mutate "ClassName.class_method_to_test" spec
+````
+
 ## Development roadmap
 
 As an experiment, I've set up a [public Trello board](https://trello.com/board/mutant/4f452510101d860b203b542d) with the development roadmap up to the 1.0 release. You can vote and comment cards to give constructive feedback to the project. Just have a look and leave a comment! :)