diff options
Diffstat (limited to 'lib/scoring/README.md')
| -rw-r--r-- | lib/scoring/README.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/lib/scoring/README.md b/lib/scoring/README.md new file mode 100644 index 0000000..dce71d0 --- /dev/null +++ b/lib/scoring/README.md @@ -0,0 +1,15 @@ +Scoring interface +================= + +Files in this directory should be _modules_ implementing the following +interface: + + - `stats_needed(Match) => Array[]=Symbol` + + Returns which statistics need to be collected for this scoring + algorithm. + + - `score(Match) => Hash[User]=Integer` + + User scores for this match, assuming statistics have been + collected. |