Update README info

This commit is contained in:
Brian Cain 2014-10-28 23:19:04 -07:00
parent cd794ad160
commit 15ca0a3b25

View file

@ -3,14 +3,26 @@ vmfloaty
A CLI helper tool for Puppet Labs vmpooler to help you stay afloat. 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 ## Install
__note:__ this doesn't work yet. Have not published this to ruby gems
``` ```
gem install vmfloaty gem install vmfloaty
``` ```
## Usage ## Usage
_note:_ subject to change
``` ```
TODO Commands:
floaty get <OPERATING SYSTEM,...> [--withpe] # Gets a VM
floaty help [COMMAND] # Describe available commands or one specific command
floaty list [PATTERN] # List all open VMs
floaty modify <HOSTNAME> # Modify a VM
floaty release <HOSTNAME> # Schedules a VM for deletion
floaty status # List status of all active VMs
``` ```