summaryrefslogtreecommitdiff
path: root/plugins/docker-machine/README.md
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2019-10-24 17:57:01 +0200
committerGitHub <noreply@github.com>2019-10-24 17:57:01 +0200
commitcad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9 (patch)
tree2b07ec259bbd2b1a4919245669900a87fa87a03b /plugins/docker-machine/README.md
parent225425fe091ca052997833279ccc08643818c24a (diff)
parent40df67bc3b9b51caa24df5d220487043040d1f9a (diff)
downloadzsh-cad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9.tar.gz
zsh-cad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9.tar.bz2
zsh-cad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9.zip
Merge branch 'master' into fabric_task_description
Diffstat (limited to 'plugins/docker-machine/README.md')
-rw-r--r--plugins/docker-machine/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/plugins/docker-machine/README.md b/plugins/docker-machine/README.md
new file mode 100644
index 000000000..308a6cfdb
--- /dev/null
+++ b/plugins/docker-machine/README.md
@@ -0,0 +1,19 @@
+# docker-machine plugin for oh my zsh
+
+### Usage
+
+#### docker-vm
+Will create a docker-machine with the name "dev" (required only once)
+To create a second machine call "docker-vm foobar" or pass any other name
+
+#### docker-up
+This will start your "dev" docker-machine (if necessary) and set it as the active one
+To start a named machine use "docker-up foobar"
+
+#### docker-switch dev
+Use this to activate a running docker-machine (or to switch between multiple machines)
+You need to call either this or docker-up when opening a new terminal
+
+#### docker-stop
+This will stop your "dev" docker-machine
+To stop a named machine use "docker-stop foobar" \ No newline at end of file