puppetlabs/vmfloaty
2
0
Fork 0
mirror of https://github.com/puppetlabs/vmfloaty.git synced 2026-01-26 05:28:40 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #151 from puppetlabs/readme-cleanup

Browse source 
Minor cleanup to the readme
This commit is contained in:
Heath Seals 2021-10-12 12:44:49 -05:00 • committed by GitHub
commit ecf8925775
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,11 +1,9 @@
# vmfloaty # vmfloaty
[![Gem Version](https://badge.fury.io/rb/vmfloaty.svg)](https://badge.fury.io/rb/vmfloaty) [![Gem Version](https://badge.fury.io/rb/vmfloaty.svg)](https://badge.fury.io/rb/vmfloaty)
[![Build Status](https://github.com/puppetlabs/vmfloaty/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/puppetlabs/vmfloaty/actions/workflows/ci.yml) [![CI](https://github.com/puppetlabs/vmfloaty/actions/workflows/ci.yml/badge.svg)](https://github.com/puppetlabs/vmfloaty/actions/workflows/ci.yml)
[![Coverage Status](https://github.com/puppetlabs/vmfloaty/badge.svg?branch=main)](https://coveralls.io/github/puppetlabs/vmfloaty?branch=main)
[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=puppetlabs/vmfloaty)](https://dependabot.com)
A CLI helper tool for [Puppet's vmpooler](https://github.com/puppetlabs/vmpooler) to help you stay afloat. A CLI helper tool for [Puppet's VMPooler](https://github.com/puppetlabs/vmpooler) to help you stay afloat.
![float image](float.jpg) ![float image](float.jpg)
@ -18,7 +16,7 @@ A CLI helper tool for [Puppet's vmpooler](https://github.com/puppetlabs/vmpooler
- [Using backends besides VMPooler](#using-backends-besides-vmpooler) - [Using backends besides VMPooler](#using-backends-besides-vmpooler)
- [Valid config keys](#valid-config-keys) - [Valid config keys](#valid-config-keys)
- [Tab Completion](#tab-completion) - [Tab Completion](#tab-completion)
- [vmpooler API](#vmpooler-api) - [VMPooler API](#vmpooler-api)
- [Using the Pooler class](#using-the-pooler-class) - [Using the Pooler class](#using-the-pooler-class)
- [Example Projects](#example-projects) - [Example Projects](#example-projects)
- [Special thanks](#special-thanks) - [Special thanks](#special-thanks)
@ -41,7 +39,7 @@ $ floaty --help
DESCRIPTION: DESCRIPTION:
A CLI helper tool for Puppet's vmpooler to help you stay afloat A CLI helper tool for Puppet's VMPooler to help you stay afloat
COMMANDS: COMMANDS:
@ -151,13 +149,13 @@ There is also tab completion for zsh:
source $(floaty completion --shell zsh) source $(floaty completion --shell zsh)
``` ```
## vmpooler API ## VMPooler API
This cli tool uses the [vmpooler API](https://github.com/puppetlabs/vmpooler/blob/master/API.md). This cli tool uses the [VMPooler API](https://github.com/puppetlabs/vmpooler/blob/master/API.md).
## Using the Pooler class ## Using the Pooler class
vmfloaty providers a `Pooler` class that gives users the ability to make requests to vmpooler without having to write their own requests. It also provides an `Auth` class for managing vmpooler tokens within your application. vmfloaty providers a `Pooler` class that gives users the ability to make requests to VMPooler without having to write their own requests. It also provides an `Auth` class for managing VMPooler tokens within your application.
### Example Projects ### Example Projects