README.md in minke-0.14.0 vs README.md in minke-0.15.0

- old
+ new

@@ -6,10 +6,18 @@ **Version 0.13.0** [![Build Status](https://travis-ci.org/nicholasjackson/minke.svg?branch=master)](https://travis-ci.org/nicholasjackson/minke) Minke is an opinionated build system for Microservices and Docker, like a little envelope of quality it scaffolds the build, run and test (unit test and functional tests) phases of your microservice project allowing you to simply run and test your images using Docker Compose. Currently supporting Google's Go, and experimental support for Swift, extensions are planned for Node.js or HTML / Javascript sites with Grunt or Gulp based builds. +## Supported languages +- Go +- Swift + +## Languages coming soon +- Node +- Java + ## Installation Add this line to your application's Gemfile: ```ruby @@ -30,10 +38,16 @@ You need to have docker, docker-machine, and docker-compose installed on your build machine and the docker environment variables must be set. If using the docker-toolkit on a mac you can set these by running... ```bash eval "$(docker-machine env default)" ``` +## Not for Docker for Mac Beta users +If you use docker for mac please set the environment variable, this will auto resolve once Docker for mac exits beta. +``` +DOCKER_IP=[your docker vm ip] +``` + ## Usage Include the rake tasks in your Rakefile ```ruby require 'minke' @@ -78,10 +92,13 @@ email: <%= ENV['DOCKER_REGISTRY_EMAIL'] %> namespace: <%= ENV['DOCKER_NAMESPACE'] %> docker: docker_file: './dockerfiles/event-sauce/Dockerfile' compose_file: './dockercompose/event-sauce/docker-compose.yml' + build: + image: [optional] + docker_file: [optional] after_build: copy_assets: - from: <%= "#{ENV['GOPATH']}/src/github.com/nicholasjackson/event-sauce/event-sauce" %> to: './docker/event-sauce' @@ -129,10 +146,13 @@ **to:** the destination file or directory #### docker: This section contains configuration for the Docker build and run process. **docker_file:** path to the folder containing your Dockerfile used by the build_server task. -**compose_file:** path to your docker-compose file for run and cucumber tasks. +**compose_file:** path to your docker-compose file for run and cucumber tasks. +**build:** This section allows you to override the language default used for building your application code. +- **image [optional]:** specify a different image from your registry or local machine to use for building the application. +- **docker_file [optional]:** specify a dockerfile which will be built into an image and then used for building the application. #### run: The run section defines config for running your microservice with Docker Compose. ##### consul_loader: When the application is run using docker-compose you can load some default config into your consul server. Told you this was opinionated, if you are building microservices you are using consul right?