Edited README requiring NewsAPI Key

README.md

@@ -2,6 +2,8 @@
 
 StockTracker is a Python application that help analyse and visualise stock performance data for a list of companies. It provides a user-friendly GUI for comparing stock prices, viewing historical trends, and staying updated with the latest news.
 
+Please head to [StockTracker](https://wleong1.github.io/StockTracker/) for more detailed explanation.
+
 ## Table of Contents
 
 - [Project Description](#project-description)

docs/how-to-guides.md

@@ -11,12 +11,15 @@ The ***web app container*** receives the data from the ***business logic contain
 As each container depends on one another. It is vital to set them up accordingly. Before you start, ensure that you have the folllowing dependencies installed:
 -  Docker
 -  net-tools (to get your IP address)
+-  API Key from NewsAPI
 -  vim (optional)
 
 ## To set-up
 
 1. Clone the project repository using Git.
 
+2. Paste NewsAPI Key into *parameters.py* under *NEWS_API_KEY*
+
 2. There are three methods to provide the ***database container*** with the backup (*.dump*) file:
 
     === "The NFS method"

src/parameters.py

@@ -1,3 +1,3 @@
 "This module stores the required keys."
-NEWS_API_KEY = "ba1ce03bb02f432ca6f88efb7b475a47"
+NEWS_API_KEY = ""
 ALPHA_VANTAGE_API_KEY = ""