Merge pull request #28 from gmbrax/dependabot/pip/textual-approx-eq-3.6.0

Update textual requirement from ~=3.3.0 to ~=3.6.0

CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Planned
+
+- Installation Method 1 (repository compilation)
+- Organization of trips by date, location, or theme
+- Enhanced photo management features
+- Search functionality
+- Export features
+- Testing implementation
+
+## [0.0.1] - 2025-07-06
+
+### Added
+
+- Initial alpha release of Pilgrim travel diary application
+- Create and edit travel diaries
+- Create and edit diary entries
+- Photo ingestion system
+- Photo addition and reference via sidebar
+- Text User Interface (TUI) built with Textual framework
+- Pre-compiled binary installation method (Method 2)
+- Support for Linux operating systems
+- Basic project documentation (README)
+
+### Known Issues
+
+- Installation Method 1 not yet implemented
+- No testing suite implemented yet
+- Some features may be unstable in alpha version
+
+[Unreleased]: https://github.com/username/pilgrim/compare/v0.0.1...HEAD
+
+[0.0.1]: https://github.com/username/pilgrim/releases/tag/v0.0.1

README.md

@@ -1,16 +1,17 @@
-# Python_Pilgrim
+# Pilgrim
 
 ## 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.
+**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
+- Store photos and add them to the diary entry
 
 ## Requirements
 - Python 3.8 or higher
@@ -21,30 +22,25 @@
 
 ## Installation
 
-1. Clone the repository:
+To install the application you must issue the command:
+
 ```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
+pip install pilgrim
 ```
 
 ## Usage
 
-To run the main application, execute:
-
+To use application you just issue:
 ```bash 
-python <???>.py
+pilgrim
 ```
 
-This will start the Python_Pilgrim application. Follow the on-screen instructions to create and manage your travel diaries.
+This will start the Pilgrim application. Follow the on-screen instructions to create and manage your travel diaries.
+
+## Changelog
+
+To see all the changes in the current version, please refer to the [CHANGELOG](CHANGELOG.md)
+
+## License
+
+This project is licensed under the BSD 3-Clause License — see the [LICENSE](LICENSE) file for details.

requirements.txt

@@ -3,4 +3,4 @@ SQLAlchemy==2.0.41
 typing_extensions==4.14.0
 
 
-textual~=3.3.0
+textual~=3.6.0