From 0b738397d84b139f6dfbb7d90f212029b041780b Mon Sep 17 00:00:00 2001 From: Brady Fomegne Date: Thu, 1 May 2025 21:13:34 +0100 Subject: [PATCH] doc: improve the `README.md` This commit adds a preview image of the app, fix the markdown formatting and fix the deployment instruction --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 376efe0..91e69bc 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # place +![Screenshot From 2025-05-01 21-09-07](https://github.com/user-attachments/assets/d62aabeb-3c84-49a2-b12d-a0056b3a2877) + An event application for Cameroon that helps users find events based on their interests, location, and availability. ## Deployment Guide @@ -13,7 +15,6 @@ An event application for Cameroon that helps users find events based on their in ### Setup Instructions **Install Dependencies** - ``` - **With Python:** ```sh pip install . @@ -59,7 +60,7 @@ An event application for Cameroon that helps users find events based on their in ``` - **With Docker:** ```sh - docker compose exec place-web shell -c \"import core.dummy_data\" + docker compose exec place-web ./entrypoint.sh shell -c \"import core.dummy_data\" ``` **Access the webapp**