Skip to content

Commit 812feba

Browse files
committed
Update README.md
1 parent ed31fc4 commit 812feba

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,15 @@ A simple library to display tournament brackets (round-robin, single elimination
99

1010
It contains all the logic needed to display tournaments.
1111

12-
- Supports translation ([i18next](https://www.i18next.com/))
13-
- Full vanilla JS (no framework)
12+
### Features
13+
14+
- Supports translation ([i18next](https://www.i18next.com/)), which also allows you to change the vocabulary
15+
- It was developed in vanilla JS, so you can [use it in any framework](https://github.com/Drarig29/brackets-viewer.js/discussions/74)
1416
- A full working example of creating and displaying brackets (see [`./demo/with-ui.html`](demo/with-ui.html))
1517
- Themes supported, with CSS variables (see [`./demo/themes`](/demo/themes))
18+
- Display participant images next to their name ([example](https://github.com/Drarig29/brackets-viewer.js/blob/668aae1ed9db41ab21665459635cd6b71cad247c/demo/with-api.html#L34-L38))
19+
- Do actions when a match is clicked ([example](https://github.com/Drarig29/brackets-viewer.js/blob/ed31fc4fc43336d3543411f802a8b1d9d592d467/demo/with-api.html#L53), [feature request](https://github.com/Drarig29/brackets-viewer.js/discussions/80))
20+
- Custom round names: do you want to say "Semi Finals" instead of "Round 2"? ([example](https://github.com/Drarig29/brackets-viewer.js/blob/ed31fc4fc43336d3543411f802a8b1d9d592d467/demo/with-api.html#L46-L52), [feature request](https://github.com/Drarig29/brackets-viewer.js/discussions/93))
1621

1722
![Screenshot](screenshot.png)
1823

0 commit comments

Comments
 (0)