Skip to content

Commit

Permalink
(#6) Write up simple introduction workflow in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
briancain committed Oct 2, 2015
1 parent c75bc69 commit 19d409b
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 19d409b

Please sign in to comment.