993b94ac8ee4fa02dfb60bab89ddcc2d23ecc341
Christian Fraß [add] readme

Christian Fraß authored 2 years ago

1) # Information
2) 
3) A simple mediator between an IRC server and a web application
4) 
5) 
Christian Fraß [mod] stateless

Christian Fraß authored 2 years ago

6) # Dependencies
7) 
8) - [node irc](https://node-irc.readthedocs.io/en/latest/)
9) 
10) 
Christian Fraß [mod] readme

Christian Fraß authored 2 years ago

11) # Licence
12) 
13) - model: GPLv3
14) - author: svartoyg
15) 
16) 
Christian Fraß [add] readme

Christian Fraß authored 2 years ago

17) # Building
18) 
19) ## Requirements
20) 
21) - TypeScript compiler
22) - GNU Make
23) 
24) 
25) ## Procedure
26) 
Christian Fraß [mod] logging [mod] code st...

Christian Fraß authored 2 years ago

27) - create a configuration file in the `conf` directory (e.g. `foobar.json`); deriving from `conf/example.json` might be a good idea
28) - run `tools/build [<conf-profile>]` (e.g. `tools/build foobar`)
Christian Fraß [add] readme

Christian Fraß authored 2 years ago

29) 
30) 
31) # Running
32) 
Christian Fraß [mod] web-irc -> wirc

Christian Fraß authored 2 years ago

33) After building just execute `cd build && ./wirc`!
Christian Fraß [add] readme

Christian Fraß authored 2 years ago

34) 
Christian Fraß [mod] readme

Christian Fraß authored 2 years ago

35) 
36) # Plans and ToDos
37) 
38) - support commands (e.g. `/nick new_name`)
Christian Fraß [mod] stateless

Christian Fraß authored 2 years ago

39) - support for actions (e.g. `/me smiles`)
40) - add join and part events to `fetch`
41) - support topic