README.md in tanuki-universe-0.0.3 vs README.md in tanuki-universe-0.0.4

- old
+ new

@@ -2,10 +2,20 @@ Generate universe file from private Gitlab. Please see the following URL(https://docs.chef.io/api_chef_server.html#universe). +## Caution(2017/11/09)⚠️ + +Please add this to Gemfile. +``` +gem 'gitlab', git: 'https://github.com/NARKOZ/gitlab.git' +``` +It needs to be obtained from master branch to require fixes not included in the latest release. + + + ## Installation Add this line to your application's Gemfile: ```ruby @@ -41,13 +51,24 @@ "group" can be omitted. In that case, It will search for Cookbook from all repositories. You can also use environment variables. - ENV['GITLAB_API_ENDPOINT'] -- ENV['GITLAB_API_PRIVATETOKEN'] +- ENV['GITLAB_API_PRIVATE_TOKEN'] - ENV['GITLAB_COOKBOOKS_GROUP'] -In this case 'config.json' is unnecessary. +Even then you need config file below. +``` +{ + "endpoints": [ + { + "type": "gitlab", + "options": {} + } + ] +} +``` + ``` Commands: tanuki-universe generate # Generate universe file. tanuki-universe help [COMMAND] # Describe available commands or one specific command