README.md in gitlab-3.4.0 vs README.md in gitlab-3.5.0

- old
+ new

@@ -86,10 +86,21 @@ For more information, refer to [documentation](http://rubydoc.info/gems/gitlab/frames). ## CLI +Configuration example: + +```sh +export GITLAB_API_ENDPOINT=https://gitlab.yourcompany.com/api/v3 +export GITLAB_API_PRIVATE_TOKEN=<your private token from /profile/account> +# This one is optional and can be used to set any HTTParty option you may need +# using YAML hash syntax. For example, this is how you would disable SSL +# verification (useful if using a self-signed cert). +export GITLAB_API_HTTPARTY_OPTIONS="{verify: false}" +``` + Usage examples: ```sh # list users gitlab users @@ -103,10 +114,13 @@ # filter output gitlab user --only=id,username gitlab user --except=email,bio +# get a user and render result as json +gitlab user 2 --json + # passing options hash to a command (use YAML) gitlab create_merge_request 4 "New merge request" "{source_branch: 'new_branch', target_branch: 'master', assignee_id: 42}" ``` @@ -131,9 +145,17 @@ gitlab> create_merge_request 4 "New merge request" "{source_branch: 'new_branch', target_branch: 'master', assignee_id: 42}" ``` Web version is available at https://gitlab-live.herokuapp.com For more information, refer to [website](http://narkoz.github.io/gitlab). + +## Development + +After checking out the repo, run `bin/setup` to install dependencies. Then, run +`rake spec` to run the tests. You can also run `bin/console` for an interactive +prompt that will allow you to experiment. + +For more information see [CONTRIBUTING.md](https://github.com/NARKOZ/gitlab/blob/master/CONTRIBUTING.md). ## License Released under the BSD 2-clause license. See LICENSE.txt for details.