From 0f66954211af0ac6d4b957270153aef2b03f0b5c Mon Sep 17 00:00:00 2001 From: Cankat Date: Sun, 27 Feb 2022 02:08:42 +0300 Subject: [PATCH] update readme --- README.md | 6 ++++-- package.json | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index be5e558..a198ca3 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,10 @@ console.log(fixtureCreator.createLeagueFixture(teams)); `teams` should be a array of team names as a string
`teams` must have at least 2 team
-if `teams` length is odd, the team that will not play that week is shown to face `'BYE-THIS-WEEK'`.
- +if `teams` length is odd, the team that will not play that week is shown to face `'BYE-THIS-WEEK'`. If you prefer dash(`-`) instead of this text, you have to write false after team string
+```ts +console.log(fixtureCreator.createLeagueFixture(teams, false)); +``` `fixtureCreator.createLeagueFixture(teams)` returns fixture object. fixture object contains game weeks array.
``` diff --git a/package.json b/package.json index 9a7eaa3..53c0c34 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "fixture-creator", - "version": "0.1.0", + "version": "0.1.1", "description": "Round-robin tournament based sports fixture creator", "main": "dist/main.js", "types": "dist/main.d.ts",