mirror of
https://github.com/nikdoof/grumble.git
synced 2025-12-13 08:42:15 +00:00
Update to README
Add requirements and Mumble supported version information.
This commit is contained in:
20
README.md
20
README.md
@@ -1,4 +1,4 @@
|
||||
grumble
|
||||
Grumble
|
||||
=======
|
||||
|
||||
A Small, RESTful API wrapper for Mumble servers.
|
||||
@@ -8,6 +8,24 @@ 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
|
||||
-----------------------
|
||||
|
||||
|
||||
Reference in New Issue
Block a user