Skip to content

Commit ea4bcaa

Browse files
committed
key → private_key
Updates the default params to use the new `private_key` param. Updates the README to document the new method for obtaining a key.
1 parent f0b83b7 commit ea4bcaa

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Full documentation for this library can be found [here](https://xivapi.github.io
2222

2323
## Usage
2424

25-
Start by initializing a client. You can obtain an API key by creating a new XIVAPI application [here](https://www.xivapi.com/app).
25+
Start by initializing a client. You can obtain an API key by signing in to XIVAPI [here](https://www.xivapi.com/app). The key is available under the Dev Account page after signing in.
2626

2727
```rb
2828
require 'xivapi'

lib/xivapi.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ def poll_rate=(rate)
6767

6868
# @return [Hash] The default parameters for the client
6969
def default_params
70-
{ key: @api_key, language: @language }
70+
{ private_key: @api_key, language: @language }
7171
end
7272
end
7373
end

0 commit comments

Comments
 (0)