README.md in preservation-client-2.2.0 vs README.md in preservation-client-3.0.0
- old
+ new
@@ -35,28 +35,30 @@
end
private
def client
- @client ||= Preservation::Client.configure(url: Settings.preservation_catalog.url)
+ @client ||= Preservation::Client.configure(url: Settings.preservation_catalog.url, token: Settings.preservation_catalog.token)
end
```
OR
```ruby
require 'preservation/client'
def initialize
- Preservation::Client.configure(url: Settings.preservation_catalog.url)
+ Preservation::Client.configure(url: Settings.preservation_catalog.url, token: Settings.preservation_catalog.token)
end
def do_the_thing
current_version_as_integer = Preservation::Client.current_version('druid:oo000oo0000')
end
```
-Note that the client may **not** be used without first having been configured, and the `url` keyword is **required**.
+Note that the client may **not** be used without first having been configured, and both the `url` and `token` keywords are **required**.
+
+See https://github.com/sul-dlss/preservation_catalog#api for info on obtaining a valid API token.
Note that the preservation service is behind a firewall.
## API Coverage