From 15ca0a3b2599f3e2566bb10bd03bd750e3d523fd Mon Sep 17 00:00:00 2001 From: Brian Cain Date: Tue, 28 Oct 2014 23:19:04 -0700 Subject: [PATCH] Update README info --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 21cc9bf..a9cf67d 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,26 @@ vmfloaty A CLI helper tool for Puppet Labs vmpooler to help you stay afloat. +_NOTE:_ Hack day(s?) project... we'll see where this goes :) + ## Install +__note:__ this doesn't work yet. Have not published this to ruby gems + ``` gem install vmfloaty ``` ## Usage +_note:_ subject to change + ``` -TODO +Commands: + floaty get [--withpe] # Gets a VM + floaty help [COMMAND] # Describe available commands or one specific command + floaty list [PATTERN] # List all open VMs + floaty modify # Modify a VM + floaty release # Schedules a VM for deletion + floaty status # List status of all active VMs ```