From 190cef26277f3c25c08afd93375bd4ceb0466cc8 Mon Sep 17 00:00:00 2001
From: Matheus Toledo <matheus.tererj@hotmail.com>
Date: Mon, 16 Jun 2025 12:31:05 -0300
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs:=20update=20README=20with?=
 =?UTF-8?q?=20project=20overview,=20features,=20requirements,=20installati?=
 =?UTF-8?q?on,=20and=20usage=20instructions?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 49 ++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 48 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index d9baacb..7d8d17a 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,50 @@
 # Python_Pilgrim
 
-Python Based Travel Diary
\ No newline at end of file
+## Overview
+
+**Python_Pilgrim** is a Python-based travel diary application designed to help users document and manage their travel experiences. The project provides tools for recording trips, organizing travel notes, and storing memories in a structured and accessible format.
+
+## Features
+
+- Create and manage travel diaries
+- Add, edit, and delete travel entries
+- Organize trips by date, location, or theme
+- Store photos, notes, and other media
+- Export and share travel logs
+
+## Requirements
+- Python 3.8 or higher
+- Linux operating system (tested on Ubuntu 20.04+)
+- Visual Studio Code (VSCode) for development (optional but strongly recommended)
+- pip (Python package installer)
+- Optional: virtualenv for isolated environments
+
+## Installation
+
+1. Clone the repository:
+    ```bash
+    git clone https://github.com/gmbrax/Pilgrim.git
+    ```
+2. Navigate to the project directory:
+    ```bash
+    cd Pilgrim
+    ```
+3. Create a virtual environment and, then, activate it:
+    ```bash
+    python -m venv .venv
+    source .venv/bin/activate
+    ```
+4. Install the required dependencies:
+    ```bash
+    pip install -r requirements.txt
+    ```
+
+## Usage
+
+To run the main application, execute:
+
+```bash
+python <???>.py
+```
+
+This will start the Python_Pilgrim application. Follow the on-screen instructions to create and manage your travel diaries.
\ No newline at end of file