(maint) Update development documentation

This commit adds documentation for how to setup a development environment for
VM Pooler.  This commit also moves the API under the new docs directory and
modifies the README appropriately.
This commit is contained in:
Glenn Sarti 2017-06-16 15:20:20 -07:00
parent ee3f5e2215
commit 11dd15c7a8
4 changed files with 237 additions and 1 deletions

View file

@ -74,7 +74,7 @@ vmpooler provides an API and web front-end (dashboard) on port `:4567`. See the
### API
vmpooler provides a REST API for VM management. See the [API documentation](API.md) for more information.
vmpooler provides a REST API for VM management. See the [API documentation](docs/API.md) for more information.
### Dashboard
@ -93,6 +93,10 @@ A dashboard is provided to offer real-time statistics and historical graphs. It
- [vagrant-vmpooler](https://github.com/briancain/vagrant-vmpooler) Use Vagrant to create and manage your vmpooler instances.
## Development and further documentation
For more information about setting up a development instance of vmpooler or other subjects, see the [docs/](docs) directory.
## Build status
[![Build Status](https://travis-ci.org/puppetlabs/vmpooler.png?branch=master)](https://travis-ci.org/puppetlabs/vmpooler)