From cc7faa1bc3a542e0ea057971d37aa400f711d8c0 Mon Sep 17 00:00:00 2001 From: Luke Shumaker Date: Sun, 27 Apr 2014 18:22:19 -0400 Subject: tidy up README.md's --- lib/scoring/README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'lib/scoring') 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. -- cgit v1.2.3-2-g168b