readme.md
14a9cf80
 # Information
 
 A simple mediator between an IRC server and a web application
 
 
993b94ac
 # Dependencies
 
 - [node irc](https://node-irc.readthedocs.io/en/latest/)
 
 
dfe1cb60
 # Licence
 
 - model: GPLv3
 - author: svartoyg
 
 
14a9cf80
 # Building
 
 ## Requirements
 
 - TypeScript compiler
 - GNU Make
 
 
 ## Procedure
 
a277bab9
 - create a configuration file in the `conf` directory (e.g. `foobar.json`); deriving from `conf/example.json` might be a good idea
 - run `tools/build [<conf-profile>]` (e.g. `tools/build foobar`)
14a9cf80
 
 
 # Running
 
a7ec2dea
 After building just execute `cd build && ./wirc`!
14a9cf80
 
dfe1cb60
 
 # Plans and ToDos
 
 - support commands (e.g. `/nick new_name`)
993b94ac
 - support for actions (e.g. `/me smiles`)
 - add join and part events to `fetch`
 - support topic
dfe1cb60