Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cankatabaci committed Feb 26, 2022
1 parent 60df5a8 commit 0f66954
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,10 @@ console.log(fixtureCreator.createLeagueFixture(teams));

`teams` should be a array of team names as a string<br />
`teams` must have at least 2 team<br />
if `teams` length is odd, the team that will not play that week is shown to face `'BYE-THIS-WEEK'`.<br />

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<br />
```ts
console.log(fixtureCreator.createLeagueFixture(teams, false));
```
`fixtureCreator.createLeagueFixture(teams)` returns fixture object. fixture object contains game weeks array.<br />

```
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down

0 comments on commit 0f66954

Please sign in to comment.