summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/README.md56
1 files changed, 53 insertions, 3 deletions
diff --git a/doc/README.md b/doc/README.md
index 67b026c..6d28dfa 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -12,19 +12,69 @@ https://olympics.com/en/paris-2024/sports
Pictograms:
https://olympics.com/en/paris-2024/the-games/the-brand/pictograms
-API Request for Archery Data:
+### API Request for Archery Data (replace ARC with other short from table below for different disciplines):
```js
await (await fetch("https://sph-s-api.olympics.com/summer/schedules/api/ENG/schedule/discipline/ARC", {
"method": "GET",
})).json();
```
-Table for \[ABC\]:
+
+**NOTE:** You can switch between API and mock data in "src/api/OlympicsAPI.h" with the defined value "USE_API_REQUEST".
+
+### Table for discipline short names from the IOC (International Olympics Comittee):
+
|Sport|Short|
|---|---|
+|AquaticsArtisticSwimming|SWA|
+|AquaticsDiving|DIV|
+|AquaticsMarathonSwimming|OWS|
+|AquaticsSwimming|SWM|
+|AquaticsWaterPolo|WPO|
|Archery|ARC|
-|Basketball 3v3|BK3|
+|Athletics|ATH|
+|Badminton|BDM|
+|Basketball3v3|BK3|
+|Basketball|BKB|
+|Boxing|BOX|
+|Breaking|BKG|
+|CanoeingSprint|CSP|
+|CanoeingSlalom|CSL|
+|CyclingBMXFreestyle|BMF|
+|CyclingBMXRacing|BMX|
+|CyclingMaountainBike|MTB|
+|CyclingRoad|CRD|
+|CyclingTrack|CTR|
+|EquestrianDressage|EDR|
+|EquestrianEventing|EVE|
+|EquestrianJumping|EJP|
+|Fencing|FEN|
+|FieldHockey|HOC|
+|Football|FBL|
+|Golf|GLF|
+|GymnasticsArtistic|GAR|
+|GymnasticsRhythmic|GRY|
+|GymnasticsTrampoline|GTR|
+|HandballIndoor|HBL|
+|Judo|JUD|
+|ModernPentathlon|MPN|
+|Rowing|ROW|
+|Rugby7|RU7|
+|Sailing|SAL|
+|Shooting|SHO|
+|Skateboarding|SKB|
+|SportClimbing|CLB|
+|Surfing|SRF|
+|TableTennis|TTE|
|Taekwondo|TKW|
+|Tennis|TEN|
+|Triathlon|TRI|
+|VolleyballBeach|VBV|
+|VolleyballIndoor|VVO|
+|Weightlifting|WLF|
+|WrestlingFreestyle|WRE|
+|WrestlingGrecoRoman|WRG|
+### Sport Specifics
Archery:
- rules: https://olympics.com/en/paris-2024/sports/archery