Update Readme, Version, wording

garamb1 · Mar 31, 2024 · 974c519 · 974c519
1 parent a44ea15
commit 974c519
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -17,6 +17,8 @@ RetroSearch is a Spring Web Application that presents very simple HTML pages whi
 It provides the ability to search the Web using DuckDuckGo with a custom scraper that loads the first page of results and allows you to browse pages in plain text.
 You can deploy it on your local network and access it from your old computer!
 
+## News and sports APIs support
+
 ### Enabling the News API
 
 RetroSearch can fetch news articles by using the GNews API, to allow this, add the environment variables as follows when running the Docker image:
@@ -25,8 +27,23 @@ RetroSearch can fetch news articles by using the GNews API, to allow this, add t
 docker run -e NEWS_ACTIVE=true -e NEWS_API_KEY={your GNews API Key} -d -p80:8080 garambo/retrosearch:{Retro Search Version} --restart unless-stopped
 ```
 
+### Enabling the football-data.org API
+
+RetroSearch can fetch the latest football scores using the football-data.org API, to allow this, add the environment variables as follows when running the Docker image:
+
+```
+docker run -e FOOTBALL_API_ACTIVE=true -e FOOTBALL_API_KEY={your football-data.org API Key} -d -p80:8080 garambo/retrosearch:{Retro Search Version} --restart unless-stopped
+```
+
+### Enabling both
+
+```
+docker run -e NEWS_ACTIVE=true -e NEWS_API_KEY={your GNews API Key} FOOTBALL_API_ACTIVE=true -e FOOTBALL_API_KEY={your football-data.org API Key} -d -p80:8080 garambo/retrosearch:{Retro Search Version} --restart unless-stopped
+```
+
 If running locally, just replace the property values in `application.properties` or create a new Spring run configuration.
 
+
 ### WIP
 Currently in progress:
  - Improve the parsing abilities for the browsing functionality

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-0.5.2-testing
+0.6
diff --git a/...in/java/it/garambo/retrosearch/sports/football/repository/InMemoryFootballRepository.java b/...in/java/it/garambo/retrosearch/sports/football/repository/InMemoryFootballRepository.java
@@ -33,7 +33,7 @@ public void updateAll(List<Match> newMatches) {
           updatedMatches.putIfAbsent(areaName, new HashSet<>());
           updatedMatches.get(areaName).add(match);
         });
-    log.info("Football Results updated");
+    log.info("Football scores updated");
     matchesByArea = updatedMatches;
     updatedAt = new Date();
   }

diff --git a/src/main/resources/templates/football.html b/src/main/resources/templates/football.html
@@ -5,7 +5,7 @@
 </head>
 <body>
 <th:block th:insert="fragments/header.html"></th:block>
-<h2>Latest football results</h2>
+<h2>Latest football scores</h2>
 <p>Updated: <em th:text="${updatedAt}"></em></p>
 <ul>
     <li th:each="matchesByCountry: ${results}">

diff --git a/src/main/resources/templates/fragments/header.html b/src/main/resources/templates/fragments/header.html
@@ -1,7 +1,7 @@
 <a href="/"><img th:src="@{__${@logoPath}__}" alt="A RetroSearch Logo"></a>
 <th:block th:if="${@environment.getProperty('retrosearch.news.enable') and
                    @environment.getProperty('retrosearch.sports.football.enable')}">
-    <h4><a href="/">Search and Browse</a> - <a href="/news">News</a> - <a href="/football">Football results</a></h4>
+    <h4><a href="/">Search and Browse</a> - <a href="/news">News</a> - <a href="/football">Football scores</a></h4>
 </th:block>
 <form action="/search" method="get">
     Search Query:<input type="text" th:value="${searchResults?.query}" name="query">