implemnted cr

README.md

@@ -4,6 +4,7 @@
 [![GitHub open issues](https://img.shields.io/github/issues/bptlab/TracEX)](https://github.com/bptlab/TracEX/issues)
 [![GitHub closed pull requests](https://img.shields.io/github/issues-closed/bptlab/TracEX)](https://github.com/bptlab/TracEX/issues)
 [![GitHub open pull requests](https://img.shields.io/github/issues-pr/bptlab/TracEX)](https://github.com/bptlab/TracEX/issues)
+[![Pylint](https://github.com/bptlab/tracex/actions/workflows/pylint.yml/badge.svg)](https://github.com/bptlab/TracEX/blob/main/.github/workflows/pylint.yml)
 
 TracEX aims to extract event logs from unstructured text, specifically written patient experiences known as patient journeys. By leveraging Large Language Models (LLMs), TracEX can automatically identify and extract relevant events, activities, timestamps and further information from natural langauge text. This enables healthcare professionals and researchers to gain valuable insights into patient experiences, treatment pathways, and potential areas for improvement in healthcare delivery.
 
@@ -17,41 +18,41 @@ This project was initiated and completed as part of the team's bachelor's degree
 - **Intuitive UI**: User-friendly interface for you to interact with the tool and visualize results.
 
 ## Requirements
-To run TracEX successfully, it is essential to obtain an OpenAI API key with adequate credits. TracEX integrates the OpenAI API to leverage Large Language Models (LLMs) for extracting relevant information from unstructured text. Without a valid API key and sufficient balance, the extraction process cannot be performed.
+To run TracEX successfully, it is essential to obtain an OpenAI API GPT 3.5 key with adequate credits. TracEX integrates the OpenAI API to leverage Large Language Models (LLMs) for extracting relevant information from unstructured text. Without a valid API key and sufficient balance, the extraction process cannot be performed. The current prices for API can be looked up at [OpenAI Pricing](https://openai.com/api/pricing/).
 
 ## Installation using Docker
 **Option 1: Using a Pre-built Docker Image** \
 The easiest way to run a local instance of TracEX is using the provided Docker image.
 
-1. Install Docker: Ensure that you have Docker installed on your system. If you haven't installed it yet, please follow the official Docker installation guide for your operating system: Docker Installation.
+1. Install Docker: Ensure that you have Docker installed on your system. If you haven't installed it yet, please follow the official Docker installation guide for your operating system.
 1. Download the Latest Docker Image: Download the latest TracEX Docker image from the provided link: docker image
 1. Load the Docker Image: Open a terminal or command prompt and navigate to the directory where you downloaded the Docker image file. Run the following command to load the image: `docker load -i tracex.tar`\
-Note: Depending on your system configuration, you may need to run this command with sudo privileges.
+Note: Depending on your system configuration, you may need to run this command with `sudo` privileges.
 1. Run the Docker Container: After the image is successfully loaded, run the following command to start the TracEX container: `docker run -p 8000:8000 tracex`\
-This command will start the container and map port 8000 from the container to port 8000 on your local machine. Again, you may need to use sudo depending on your system setup.
+This command will start the container and map port 8000 from the container to port 8000 on your local machine. Again, you may need to use `sudo` depending on your system setup.
 1. Access TracEX: Open a web browser and navigate to http://localhost:8000/. This will bring you to the TracEX application, where you can enter your OpenAI Key and start extracting event logs.
 
 **Option 2: Building the Docker Image from Source** \
 Alternatively, you can build the Docker image from the TracEX source code.
 
-1. Clone the TracEX Repository: Open a terminal or command prompt and navigate to the directory where you want to clone the TracEX repository. Run the following command to clone the repository: git clone https://github.com/bptlab/TracEX
+1. Clone the TracEX Repository: Open a terminal or command prompt and navigate to the directory where you want to clone the TracEX repository. Run the following command to clone the repository: `git clone https://github.com/bptlab/TracEX`
 1. Navigate to the TracEX Directory: Change your current directory to the cloned TracEX repository: `cd TracEX`
 1. Build the Docker Image: Run the following command to build the TracEX Docker image: `docker build -t tracex .`\
-Note: Depending on your system configuration, you may need to run this command with sudo privileges.
+Note: Depending on your system configuration, you may need to run this command with `sudo` privileges.
 1. Run the Docker Container: After the image is successfully built, run the following command to start the TracEX container: `docker run -p 8000:8000 tracex`\
-This command will start the container and map port 8000 from the container to port 8000 on your local machine. Again, you may need to use sudo depending on your system setup.
+This command will start the container and map port 8000 from the container to port 8000 on your local machine. Again, you may need to use `sudo` depending on your system setup.
 1. Access TracEX: Open a web browser and navigate to http://localhost:8000/. This will bring you to the TracEX application, where you can enter your OpenAI Key and start extracting event logs.
 
 ## Local Setup for Development
 
 ### Download
 
-- Use git and run "git clone https://github.com/bptlab/TracEX" in the desired directory _(Using e.g. Git Bash)_
+- Use git and run `git clone https://github.com/bptlab/TracEX` in the desired directory _(Using e.g. Git Bash)_
 
 ### Installation
 - navigate to the root directory of TracEX in your terminal
 - run `install-dependencies-unix.sh` or `install-dependencies-windows.ps1`, based on your operating system _(Using e.g. Terminal)_
-- run `python tracex_project/manage.py migrate` to update the database and apply all changes stored in the `migrations` folder
+- run `python tracex_project/manage.py migrate` to update the database and apply all changes stored in the `migrations/` folder
 
 ### Execution
 - Run `python tracex_project/manage.py runserver` in the root directory of TracEX _(Using e.g. Terminal)_