Skip to content

Commit a7cc0e2

Browse files
committed
Add Authorization documentation
1 parent aae1d60 commit a7cc0e2

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,17 @@ Alternatively, cortex-client will handle OAuth2 authentication for you:
2222
```ruby
2323
require 'cortex-client'
2424

25-
client = Cortex::Client.new(key: 'my-app-id', secret: 'secrey-key-ssh', base_url: 'base_url', scopes: 'view:posts view:media')
25+
client = Cortex::Client.new(key: 'my-app-id', secret: 'my-app-secret', base_url: 'base_url', scopes: 'view:posts view:media')
2626

2727
client.posts.query().each do |post|
2828
puts post
2929
end
3030
```
3131

32+
## Authorization
33+
34+
For more information about `scopes` and how to obtain an application `key` and `secret`, check [Cortex's authorization documentation](https://github.com/cbdr/cortex#authorization).
35+
3236
## Result object
3337

3438
Cortex::Client will return a Cortex::Result object. The following methods are available:

0 commit comments

Comments
 (0)