README.md in shipengine_ruby-0.0.1 vs README.md in shipengine_ruby-0.0.2
- old
+ new
@@ -7,8 +7,20 @@
Quick Start
===========
Install ShipEngine via [RubyGems](https://rubygems.org/)
```bash
-gem install shipengine
+gem install shipengine_ruby
```
-- The only configuration requirement is an [API Key](https://www.shipengine.com/docs/auth/#api-keys).
+- The only configuration requirement is an [API Key](https://www.shipengine.com/docs/auth/#api-keys).
+
+Configure ShipEngine
+```ruby
+ShipEngine.configure do |config|
+ config.api_key = ShipEngine::Constants::API_KEY
+ config.base_url = ShipEngine::Constants::PROD_URL
+ config.retries = ShipEngine::Constants::RETRIES
+ config.timeout = ShipEngine::Constants::TIMEOUT
+ config.page_size = ShipEngine::Constants::PAGE_SIZE
+end
+```
+or set the environment variable `API_KEY`
\ No newline at end of file