From 19d409b722e1d8c0f98b6da181783edc52448244 Mon Sep 17 00:00:00 2001 From: Brian Cain Date: Thu, 1 Oct 2015 19:45:05 -0700 Subject: [PATCH] (#6) Write up simple introduction workflow in readme --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index b69c661..06de9ae 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,22 @@ gem install vmfloaty Display backtrace when an error occurs ``` +### Example workflow + +Grabbing a token for authenticated pooler requests: + +``` +floaty token get --user me --url https://vmpooler.mycompany.net +``` + +This command will then ask you to log in. If successful, it will return a token that you can save either in a dotfile or use with other cli commands. + +Grabbing vms: + +``` +floaty get centos-7,debian-7,windows-10 --token mytokenstring --url https://vmpooler.mycompany.net +``` + ### vmfloaty dotfile If you do not wish to continuely specify various config options with the cli, you can have a dotfile in your home directory for some defaults. For example: