From a04cbb99807a75aec33613c79bf4d9b67639aa35 Mon Sep 17 00:00:00 2001 From: Andrew Date: Mon, 4 Nov 2013 23:01:54 +0000 Subject: [PATCH] Updated README. --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f34cff4..bf62b58 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,16 @@ grumble ======= -A Small, RESTful API wrapper for Mumble servers. +A Small, RESTful API wrapper for Mumble servers. + +The aim is to make a simple Flask based RESTful API to reduce the effort and development time needed to interface with Mumble servers for simple administration tasks. The API will cover the majority of the available ICE RPC functions in Mumble, excluding the callback functionality. + +This application is still under heavy development and it is suggested you do not use it within a production environment. + + +Development Environment +----------------------- + +Grumble makes use of Vagrant for its development environment and a simple configuration has been provided to bootstrap a Ubuntu VM running a basic Mumble server. + +To initialize the VM run `vagrant up` in the project root directory. \ No newline at end of file