README.rdoc in trackerific-0.4.2 vs README.rdoc in trackerific-0.5.0

- old
+ new

@@ -5,10 +5,13 @@ and then run bundle install == Usage +If you would like to see a functional example of this gem in action, check out the +sample Rails app here: {package-tracker}[https://github.com/travishaynes/package-tracker] + === Configuration To take advantage of Trackerific's automatic service discovery, you will need to configure your credentials for each service. @@ -147,9 +150,17 @@ of {yardstick}[https://github.com/dkubb/yardstick] to help verify the coverage of the comments of your code. You can use the rake task: rake yardstick_measure which will generate a measurement/report.txt file. +=== Testing with Trackerific + +Trackerific provides a mocked service you can use in your unit tests of your +application. The mocked service will be available in development and test +environments only, and disabled in production. + + details = track_package("XXXXXXXXXX") # => returns a populated Trackerific::Details + details = track_package("XXXxxxxxxx") # => throws a Trackerific::Errror exception == Contributing to trackerific * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it