Merge pull request #172 from potomak/update-readme

Add explanation method to documentation
zipmark · Nov 12, 2014 · 81f37bc · 81f37bc
2 parents 3506f2e + e222d10
commit 81f37bc
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -342,6 +342,22 @@ resource "Orders" do
 end
 ```
 
+#### explanation
+
+This method takes a string representing a detailed explanation of the example.
+
+```ruby
+resource "Orders" do
+  post "/orders" do
+    example "Creating an order" do
+      explanation "This method creates a new order."
+      do_request
+      # make assertions
+    end
+  end
+end
+```
+
 #### header
 
 This method takes the header name and value. The value can be a string or a symbol. If it is a symbol it will `send` the symbol, allowing you to `let` header values.