elsanctum/tenquestionmarks
2
0
Fork 0
Code Issues 8 Pull Requests Releases Wiki Activity

actually write somewhat of a readme

Browse Source
This commit is contained in:
Adrian Malacoda 2017-02-13 00:27:02 -06:00
parent 26a6b77632
commit edef05d123
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -1,5 +1,13 @@
# tenquestionmarks chat bot # tenquestionmarks chat bot
tenquestionmarks is an extensible, scriptable chat bot. This iteration is written in rust. tenquestionmarks is an extensible, scriptable chat bot. This iteration is written in rust.
## Architecture ## Configuration
tenquestionmarks has two basic Configuration is done in TOML. By default, tenquestionmarks looks for `tenquestionmarks.toml`.
## Modules
tenquestionmarks is a series of modules. Modules produce events and consume events.
In this particular iteration of tenquestionmarks, there are at most two threads spawned for a module: an event consumer thread and an event producer thread. However, most modules will either produce or consume, not both.
## Events
Events are things such as message, join, quit.