From 59f437c72892fd958c0d3d44ea08603dc0cc9fab Mon Sep 17 00:00:00 2001 From: Andrew Williams Date: Tue, 5 Nov 2013 14:09:42 +0000 Subject: [PATCH] Update to README Add requirements and Mumble supported version information. --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bf62b58..92d2f1a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -grumble +Grumble ======= A Small, RESTful API wrapper for Mumble servers. @@ -8,9 +8,27 @@ The aim is to make a simple Flask based RESTful API to reduce the effort and dev This application is still under heavy development and it is suggested you do not use it within a production environment. +Requirements +------------ + +Grumble makes use of a few existing libraries and tools to make development: + +* Flask +* Flask-RESTful +* MumblePy + +All dependencies are covered by either the `setup.py` or `requirements.txt` + + +Mumble Support +-------------- + +At the moment Grumble supports the current stable Murmur server, version 1.2.4. This version is required for the ICE Slice file introspection used during connection setup. + + 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 +To initialize the VM run `vagrant up` in the project root directory.