summaryrefslogtreecommitdiff
path: root/lib/scoring/README.md
diff options
context:
space:
mode:
authorguntasgrewal <guntasgrewal@gmail.com>2014-04-27 20:47:42 -0400
committerguntasgrewal <guntasgrewal@gmail.com>2014-04-27 20:47:42 -0400
commit4d47e5e7b5d838173dd3ab68c293c03e03811392 (patch)
tree594659a4fbc6cbc1afd188f94f8196e203cabe31 /lib/scoring/README.md
parentdf1cda1faab97f4c424efdcf8b6822f98b73adb8 (diff)
parent9d0be853cef35412c0bfe92c80502fd9da7947f1 (diff)
Merge branch 'master' of https://github.com/LukeShu/leaguer
Diffstat (limited to 'lib/scoring/README.md')
-rw-r--r--lib/scoring/README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/lib/scoring/README.md b/lib/scoring/README.md
index 95dd5e0..5beb0a2 100644
--- a/lib/scoring/README.md
+++ b/lib/scoring/README.md
@@ -1,10 +1,15 @@
-Files in this directory should be modules implementing the following
+Scoring interface
+=================
+
+Files in this directory should be _modules_ implementing the following
interface:
- `stats_needed() => Array[i]=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.