summaryrefslogtreecommitdiff
path: root/lib/scoring
diff options
context:
space:
mode:
Diffstat (limited to 'lib/scoring')
-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.