Skip to content

Commit

Permalink
Document basic authentication.
Browse files Browse the repository at this point in the history
  • Loading branch information
raymondberg committed Nov 13, 2015
1 parent 8914759 commit 753479a
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.mkd
Expand Up @@ -389,6 +389,19 @@ Usage Examples
# Show the daily system message
Desk.system_message

# Basic authentication with username and password; not recommended

Desk.configure do |config|
config.support_email = "help@example.com"
config.subdomain = YOUR_DESK_SUBDOMAIN
config.consumer_key = YOUR_CONSUMER_KEY
config.consumer_secret = YOUR_CONSUMER_SECRET
config.auth_method = Desk::Authentication::Methods:BASIC
config.basic_auth_username = YOUR_USERNAME
config.basic_auth_password = YOUR_PASSWORD
end


Contributing
------------
In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
Expand Down

0 comments on commit 753479a

Please sign in to comment.