From d2e171b506045f63a8afc7abfad1f6eca0c7af1f Mon Sep 17 00:00:00 2001 From: Ethan Barron Date: Thu, 13 Mar 2014 16:39:23 -0500 Subject: [PATCH] #3 - Added documentation on testing --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index b7f5276..53151ac 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,16 @@ And then execute: Or install it yourself as: $ gem install kraken_ruby + +Alternatively, if you're looking to contribute to kracken_ruby, you can fork the repo and clone it. + +## Testing + +If you are doing development on the kracken_ruby codebase, you can run the tests by running from the root directory of the source code: + + $ rspec + +Please note that all tests for the *private* aspects of Kracken's API require a valid keypair. In order for those tests to pass, the keypair **must** be specified in the ```spec/kraken_key.rb``` file. ## Usage