nikdoof/grumble
1
0
Fork 0
mirror of https://github.com/nikdoof/grumble.git synced 2025-12-13 08:42:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated README.

Browse Source
This commit is contained in:
Andrew Williams
2013-11-04 23:01:54 +00:00
parent 0ba3a12c24
commit a04cbb9980
1 changed files with 13 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -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.