diff --git a/README.md b/README.md index c12a300..007e726 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,10 @@ ### Installation Instructions - Create a [virtual environment](https://docs.python.org/3/library/venv.html) -- Install the python Dependencies with `pip install -r requirements.txt` +- Install the Python dependencies with + ```sh + pip install -r requirements.txt + ``` - Copy the .env.example file as .env ```sh cp .env.example .env @@ -12,17 +15,17 @@ ### Run Locally -To run the service locally, use the following command: +- To run the service locally, use the following command: ```sh uvicorn server:app --reload ``` -### Run with Docker -To run the service using Docker, use the following command: - ```sh - sudo docker-compose up -d --build - ``` +### Run with Docker +- To run the service using Docker, use the following command: + ```sh + sudo docker-compose up -d --build + ``` ### Run Docker Compose for Production Build -Ensure that you have [Docker]((https://docs.docker.com/engine/install)) and [Docker Compose](https://docs.docker.com/compose/install/) installed. +- Ensure that you have [Docker](https://docs.docker.com/engine/install) and [Docker Compose](https://docs.docker.com/compose/install/) installed