Commit 0ddfbfff authored by Andreas Nedbal's avatar Andreas Nedbal

update README

parent 41993e6a
# shellnut
_Mumble-to-IRC/IRC-to-Mumble Chat Gateway_
## Features
* Connects to a Mumble and IRC server
* Can send messages from one server to another and vice versa
* Can list users from the entire Mumble server (+ status) and users from specified IRC-channels
* Can notify users from one server if someone on another server joins/disconnects
## What you need
* Ruby (**>=2.1.0**)
......@@ -16,7 +23,6 @@ _Mumble-to-IRC/IRC-to-Mumble Chat Gateway_
### Commands (prefix with the prefix you set in your config.yml)
* `ping` will return "pong" or, if possible, return given arguments
* `help` will show a list of available commands
* `mumble` will send a message to the Mumble server set in the config *(from IRC)*
* `irc` will send a message to the IRC server set in the config *(from Mumble)*
......@@ -25,7 +31,8 @@ _Mumble-to-IRC/IRC-to-Mumble Chat Gateway_
## Thanks to
* [nilsding](https://github.com/nilsding) for helping me to parse colors from IRC to Mumble
* [Rob1NN](https://github.com/Rob1NN) for including custom prefixes and simplifying commands
## Licensed
Licensed under the [MIT License](http://opensource.org/licenses/MIT)
\ No newline at end of file
Licensed under the [MIT License](http://opensource.org/licenses/MIT)
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment