README.md in stripe-3.0.3 vs README.md in stripe-3.1.0

- old
+ new

@@ -133,10 +133,28 @@ Please take care to set conservative read timeouts. Some API requests can take some time, and a short timeout increases the likelihood of a problem within our servers. +### Logging + +The library can be configured to emit logging that will give you better insight +into what it's doing. The `info` logging level is usually most appropriate for +production use, but `debug` is also available for more verbosity. + +There are a few options for enabling it: + +1. Set the environment variable `STRIPE_LOG` to the value `debug` or `info`: + ``` + $ export STRIPE_LOG=info + ``` + +2. Set `Stripe.log_level`: + ``` ruby + Stripe.log_level = "info" + ``` + ### Writing a Plugin If you're writing a plugin that uses the library, we'd appreciate it if you identified using `#set_app_info`: @@ -145,10 +163,17 @@ This information is passed along when the library makes calls to the Stripe API. ## Development +The test suite depends on [stripe-mock], so make sure to fetch and run it from a +background terminal ([stripe-mock's README][stripe-mock] also contains +instructions for installing via Homebrew and other methods): + + go get -u github.com/stripe/stripe-mock + stripe-mock + Run all tests: bundle exec rake Run a single test suite: @@ -161,18 +186,18 @@ Update bundled CA certificates from the [Mozilla cURL release][curl]: bundle exec rake update_certs -Update bundled OpenAPI specification from the canonical repository: +Update the bundled [stripe-mock] by editing the version number found in +`.travis.yml`. - bundle exec rake update_openapi - [api-keys]: https://dashboard.stripe.com/account/apikeys [connect]: https://stripe.com/connect [curl]: http://curl.haxx.se/docs/caextract.html [faraday]: https://github.com/lostisland/faraday [idempotency-keys]: https://stripe.com/docs/api/ruby#idempotent_requests +[stripe-mock]: https://github.com/stripe/stripe-mock <!-- # vim: set tw=79: -->