summaryrefslogtreecommitdiff
path: root/lib/seeding/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'lib/seeding/README.md')
-rw-r--r--lib/seeding/README.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/lib/seeding/README.md b/lib/seeding/README.md
index 67fc19b..d323b6d 100644
--- a/lib/seeding/README.md
+++ b/lib/seeding/README.md
@@ -1,4 +1,10 @@
-Files in this directory should implement the following interface:
+Seeding interface
+=================
-- seed_matches(tournament)
- take the matches of a tournament and the players in a tournament, assign players to teams, and teams to matches (all must exist) \ No newline at end of file
+Files in this directory should be _modules_ implement the following
+interface:
+
+ - `seed(TournamentStage)`
+
+ Take a tournament stage, assign players to teams and teams to
+ matches (matches must exist).