chore(docs): add documentation for additional components

VictorAvelar · Oct 6, 2022 · 36b8c17 · 36b8c17
1 parent 69944d3
commit 36b8c17
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -131,6 +131,38 @@ In your dashboard view you use the `livewire:fda-upcoming` component.
 
 ![Upcoming matches](media/upcoming-matches.png)
 
+### Match results
+
+This tile displays football matches resutls from the leagues you selected in `dashboard.tiles.football_data_advanced.competitions`.
+
+In your dashboard view you use the `livewire:fda-results` component.
+
+```html
+<x-dashboard>
+ <livewire:fda-results position="a1" />
+</x-dashboard>
+```
+
+#### Example
+
+![Upcoming matches](media/match-results.png)
+
+### League standings
+
+This tile displays the standings for one of your selected leagues, you need to use the league code as parameter for the component.
+
+In your dashboard view you use the `livewire:fda-results` component.
+
+```html
+<x-dashboard>
+ <livewire:fda-standings position="a1" competition="PL"/>
+</x-dashboard>
+```
+
+#### Example
+
+![Upcoming matches](media/league-standings.png)
+
 ## Testing
 
 ``` bash

diff --git a/media/league-standings.png b/media/league-standings.png
diff --git a/media/match-results.png b/media/match-results.png