Merge branch 'master' of github.com:gary-rafferty/cryptsy

gary-rafferty · Mar 24, 2015 · 71f90ce · 71f90ce
2 parents b8f7eab + 001ca24
commit 71f90ce
Showing 1 changed file with 8 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -70,9 +70,14 @@ market_ticker.instance_variables # [bid, ask]
 
 ```ruby
 # Find the orderbook for a market
-market_orderbook = Cryptsy::MarketOrderbook.find(2)
-
-market_orderbook.instance_variables # [sellorders, buyorders]
+# Available arguments are
+# limit: 1-100 (default 100)
+# type: 'Buy' or 'Sell' or 'Both' (default Both)
+# mine: boolean (default false)
+market_orderbook = Cryptsy::MarketOrderbook.find(2) 
+market_orderbook = Cryptsy::MarkerOrderbook.find(2, limit: 1, type: 'Buy', mine: true)
+
+market_orderbook.instance_variables # [sellorders, buyorders] may only be one or the other depending on method arguments
 ```
 
 ## Contributing