README.md in gitlab-3.1.0 vs README.md in gitlab-3.2.0

- old
+ new

@@ -26,22 +26,26 @@ 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 ``` +(Note: If you are using Gitlab.com's hosted service, your endpoint will be `https://gitlab.com/api/v3`) + Usage examples: ```ruby # set an API endpoint Gitlab.endpoint = 'http://example.net/api/v3' -# => "http://example.net/api/v2" +# => "http://example.net/api/v3" # set a user private token Gitlab.private_token = 'qEsq1pt6HJPaNciie3MG' # => "qEsq1pt6HJPaNciie3MG" @@ -88,9 +92,27 @@ # filter output gitlab user --only=id,username gitlab user --except=email,bio +``` + +## CLI Shell + +Usage examples: + +```sh +# start shell session +gitlab shell + +# list available commands +gitlab> help + +# list groups +gitlab> groups + +# protect a branch +gitlab> protect_branch 1 master ``` For more information, refer to [website](http://narkoz.github.io/gitlab). ## License