README.md in rocketfuel_api-0.1.3 vs README.md in rocketfuel_api-0.2.0
- old
+ new
@@ -26,11 +26,11 @@
auth_token: ENV['ROCKETFUEL_API_SANDBOX_AUTH_TOKEN']
)
# for production
connection = RocketfuelApi::Connection.new(
- uri: 'https://api.rocketfuel.com/2016'
+ uri: 'https://api.rocketfuel.com/2016',
auth_token: ENV['ROCKETFUEL_API_AUTH_TOKEN']
)
service = RocketfuelApi::Service::Company.new(connection)
service.get(10) # returns the company with the ID 10
@@ -41,12 +41,15 @@
Note: Only the `Company` Service `GET` requests are tested so far.
## Development
-To be able to run the specs, the env var `ROCKETFUEL_API_SANDBOX_AUTH_TOKEN` is needed.
+Run specs with `bundle exec rspec`.
-We run rake rubocop to make sure, everything looks good.
+To recreate or create new VCR episodes, a proper value for env var `ROCKETFUEL_API_SANDBOX_AUTH_TOKEN` is needed.
+We recommend that you set it in `.env.test` file.
+
+We run `rake rubocop` to make sure, everything looks good.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).