summaryrefslogtreecommitdiff
path: root/lib/scheduling/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/scheduling/README.md
parentdf1cda1faab97f4c424efdcf8b6822f98b73adb8 (diff)
parent9d0be853cef35412c0bfe92c80502fd9da7947f1 (diff)
Merge branch 'master' of https://github.com/LukeShu/leaguer
Diffstat (limited to 'lib/scheduling/README.md')
-rw-r--r--lib/scheduling/README.md19
1 files changed, 14 insertions, 5 deletions
diff --git a/lib/scheduling/README.md b/lib/scheduling/README.md
index 173b7be..8b21164 100644
--- a/lib/scheduling/README.md
+++ b/lib/scheduling/README.md
@@ -1,13 +1,22 @@
-Files in this directory should implement the following interface:
+Scheduling interface
+====================
+
+Files in this directory should be _classes_ implementing the following
+interface:
- `initialize(tournament_stage)`
- construct new Scheduling object from tournament_stage
+
+ Construct new Scheduling object from tournament_stage.
- `create_matches`
- creates all the matches of the current round
+
+ Creates all the matches of the current round.
- `finish_match(match)`
- progresses the match through the schedule
+
+ Progresses the match through the schedule.
- `graph`
- returns a string representation of an svg image of the current stage \ No newline at end of file
+
+ Returns a string representation of an svg image of the current
+ stage.