README.md in minke-generator-go-0.7.2 vs README.md in minke-generator-go-0.8.0

- old
+ new

@@ -1,63 +1,47 @@ +![Minke](http://minke.rocks/img/minke_logo.png) # Minke::Generators::GoMicroservice [![Build Status](https://travis-ci.org/nicholasjackson/minke-generator-go.svg?branch=master)](https://travis-ci.org/nicholasjackson/minke-generator-go) This generator creates a REST API Microservice in Go for the Minke build and test system. For information on Minke please see the documentation [http://nicholasjackson.github.io/minke/](http://nicholasjackson.github.io/minke/). ## Available variables for templates (erb style) | Variable | Description | -| ----------------------- | | +| ----------------------- | -------------------------------------- | | <%= application_name %> | The name of the application executable | | <%= namespace %> | Namespace of the application | | <%= src_root %> | Source root of the application | -## Installation - -Add this line to your application's Gemfile: - -```ruby -gem 'minke' -gem 'minke-generator-go' +### Generate a new service +```bash +$ mkdir service +$ cd service +$ curl -L -s get.minke.rocks | bash -s ' -g minke-generator-go -o $(pwd) -n nicholasjackson/service -a service' ``` -And then execute: +**NOTE:** replace *nicholasjackson/service* with your github user and application name this needs to correspond to the input namespace you would use in your go code. - $ bundle +You do not need to create this folder inside your GOPATH as all builds are run localised in a Docker container however for an effective workflow. It is very beneficial to follow the standard go conventions. -Or install it yourself: +The generator uses GO vendoring and all sub packages will be cached in the vendor folder. -``` -$ gem install minke -$ gem install minke-generator-go - -``` - -## Usage - -To scaffold a new service run: - -```bash -$ minke -g minke-generator-go -o $GOPATH/src/github.com/nicholasjackson/helloworld - -a helloworld -n github.com/nicholasjackson -``` - ## Build and test with Docker To run a build with a Docker container, to execute the functional and unit tests you can use the following commands. Please see the main Minke documentation for more information [http://nicholasjackson.github.io/minke/](http://nicholasjackson.github.io/minke/). ### Build Application Code and Execute Unit tests ```bash $ cd _build -$ bundle -$ rake app:test +$ ./minke.sh rake app:test ``` ### Build a Docker image and execute functional tests with Cucumber ```bash -$ rake app:build_image -$ rake app:cucumber +$ ./minke.sh rake app:build_image +$ ./minke.sh rake app:cucumber +``` ``` ## 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.