Merge pull request #13 from nerro/readme-beautify

Beautify README.md

Author: frapposelli

.gitignore

@@ -1,4 +1,38 @@
+#############################
+# Compiled source           #
+#############################
+dist/
+out/
 /docker-machine-driver-vmware
 /docker-machine-driver-vmware.exe
-/out
-dist/
+
+#############################
+# Go files                  #
+#############################
+*.dll
+*.dylib
+*.exe
+*.exe~
+*.so
+
+#############################
+# IDE generated files       #
+#############################
+.idea/
+.vscode/
+*.iml
+
+#############################
+# Logs and temp files       #
+#############################
+*.log
+*.out
+*.tmp
+*~
+
+#############################
+# OS generated files        #
+#############################
+Thumbs.db
+.directory
+.DS_Store

README.md

@@ -1,16 +1,31 @@
-# Docker machine vmware driver
+# Docker Machine VMware Driver
 
-This is a docker machine driver for VMware Fusion and Workstation.
+Create Docker machines locally on VMware [Fusion](https://www.vmware.com/products/fusion)
+and [Workstation](https://www.vmware.com/products/workstation).
 
-## How to consume this driver
-
-### Prerequisite
-Make sure you have VMware Workstation 14 (Windows/Linux) or VMware Fusion 10 (MacOS)
-installed on your machine. Earlier versions of Workstation/Fusion might still work
+This driver requires VMware Workstation 14 (Windows/Linux) or VMware Fusion 10 (MacOS)
+to be installed on your host. Earlier versions of Workstation/Fusion might still work
 with this driver, but it's not officially supported.
 
-### Install
-For MacOS and Linux, make sure `$GOPATH/bin` is part of your `$PATH` for MacOS and Linux.
+>
+> Docker machine has a builtin driver called `vmwarefusion`. The main difference between
+> those drivers is that `vmware` also works on VMware Workstation, while `vmwarefusion` only
+> works on VMware Fusion.
+>
+
+
+## Installation
+
+### From a Release
+
+The latest version of the `docker-machine-driver-vmware` binary is available on the
+[GithHub Releases](https://github.com/machine-drivers/docker-machine-driver-vmware/releases) page.
+Download the the binary that corresponds to your OS into a directory residing in your PATH.
+
+### From Source
+
+Make sure you have installed [Go](http://www.golang.org) and configured [GOPATH](http://golang.org/doc/code.html#GOPATH)
+properly. For MacOS and Linux, make sure `$GOPATH/bin` is part of your `$PATH` for MacOS and Linux.
 For Windows, make sure `%GOPATH%\bin` is included in `%PATH%`.
 
 Run the following command:
@@ -19,29 +34,38 @@ Run the following command:
 go get -u github.com/machine-drivers/docker-machine-driver-vmware
 ```
 
-if the `PATH` is correctly setup, you will see this if you run the command
 
-```shell
-$ docker-machine-driver-vmware
-This is a Docker Machine plugin binary.
-Plugin binaries are not intended to be invoked directly.
-Please use this plugin through the main 'docker-machine' binary.
-(API version: 1)
-```
-
-### Usage
-The driver can be consumed by `docker-machine`, or potentially other tools that are
-compatible to docker machine drivers like `minikube` (not supported yet). For
-`docker-machine`, create a docker machine is simply a command like this:
+## Usage
 
 ```shell
 $ docker-machine create --driver=vmware default
 ```
 
-## Difference between driver vmwarefusion
-Docker machine has a builtin driver called `vmwarefusion`. The main difference between
-those drivers is that `vmware` also works on VMware Workstation, while `vmwarefusion` only
-works on VMware Fusion.
+
+## Options
+
+- `--vmware-boot2docker-url`: URL for boot2docker image
+- `--vmware-configdrive-url`: URL for cloud-init configdrive
+- `--vmware-cpu-count`: Number of CPUs for the machine (-1 to use the number of CPUs available)
+- `--vmware-disk-size`: Size of disk for host VM (in MB)
+- `--vmware-memory-size`: Size of memory for host VM (in MB)
+- `--vmware-no-share`: Disable the mount of your home directory
+- `--vmware-ssh-password`: SSH password
+- `--vmware-ssh-user`: SSH user
+
+#### Environment variables and default values
+
+| CLI option                 | Environment variable   | Default                  |
+|----------------------------|------------------------|--------------------------|
+| `--vmware-boot2docker-url` | VMWARE_BOOT2DOCKER_URL | *Latest boot2docker url* |
+| `--vmware-configdrive-url` | VMWARE_CONFIGDRIVE_URL | -                        |
+| `--vmware-cpu-count`       | VMWARE_CPU_COUNT       | `1`                      |
+| `--vmware-disk-size`       | VMWARE_DISK_SIZE       | `20000`                  |
+| `--vmware-memory-size`     | VMWARE_MEMORY_SIZE     | `1024`                   |
+| `--vmware-no-share`        | VMWARE_NO_SHARE        | -                        |
+| `--vmware-ssh-password`    | VMWARE_SSH_PASSWORD    | `tcuser`                 |
+| `--vmware-ssh-user`        | VMWARE_SSH_USER        | `docker`                 |
+
 
 ## License