clarify default config options

NARKOZ · May 24, 2014 · cd5ae8b · cd5ae8b
1 parent a38ea61
commit cd5ae8b
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -28,9 +28,11 @@ Configuration example:
 
 ```ruby
 Gitlab.configure do |config|
-  config.endpoint       = 'https://example.net/api/v3' # API endpoint URL (required)
-  config.private_token  = 'qEsq1pt6HJPaNciie3MG'       # user's private token (required)
-  config.user_agent     = 'Custom User Agent'          # user agent, default to 'Gitlab Ruby Gem [version]' (optional)
+  config.endpoint       = 'https://example.net/api/v3' # API endpoint URL, default: ENV['GITLAB_API_ENDPOINT']
+  config.private_token  = 'qEsq1pt6HJPaNciie3MG'       # user's private token, default: ENV['GITLAB_API_PRIVATE_TOKEN']
+  # Optional
+  # config.user_agent   = 'Custom User Agent'          # user agent, default: 'Gitlab Ruby Gem [version]'
+  # config.sudo         = 'user'                       # username for sudo mode, default: nil
 end
 ```