From d5f686bf1e5f7d941f53c8d4392e1d79966e5ecf Mon Sep 17 00:00:00 2001
From: "georg.sinn-schirwitz" <georg.sinn-schirwitz@in-factory.com>
Date: Fri, 29 Aug 2025 15:13:27 +0200
Subject: [PATCH] basic intructions for README

---
 README.md | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 592496d..00dc513 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,24 @@
 # jobs
 
-job scraper
\ No newline at end of file
+job scraper
+
+## Features
+
+- Scrapes job listings from website (currently craigslist by region)
+- Saves job listings to a database
+- Users can search for job listings by keywords and region
+- Selection of job listings based on user preferences
+
+## Requirements
+
+- Database (MySQL/MariaDB)
+- Python 3.x
+  - Required Python packages (see requirements.txt)
+
+## Installation
+
+1. Clone the repository
+2. Create a virtual environment
+3. Install dependencies
+4. Set up environment variables
+5. Run the application