From e3e581ccd8367dd2d8e615e5b6333f3cf4766673 Mon Sep 17 00:00:00 2001
From: rattatwinko <basti.zinkl10@gmail.com>
Date: Thu, 17 Apr 2025 14:44:45 +0200
Subject: [PATCH] updated README.md and PfandApplication/main.py

---
 PfandApplication/main.py |  6 ++--
 README.md                | 70 +++++++++++++++++++++++++---------------
 2 files changed, 46 insertions(+), 30 deletions(-)

diff --git a/PfandApplication/main.py b/PfandApplication/main.py
index 3f5b937..8f6110b 100644
--- a/PfandApplication/main.py
+++ b/PfandApplication/main.py
@@ -1,7 +1,6 @@
 import tkinter as tk
-import tkinter
-import webbrowser
 from tkinter import ttk, messagebox, filedialog
+import webbrowser
 import json
 from PIL import Image, ImageTk
 import os
@@ -23,7 +22,6 @@ from PfandApplication.updater import open_updater as open_updater, run_silent_up
 from PfandApplication.tgtg_orderchecker import main as tgtg
 from PfandApplication.tgtg_orderchecker import setupkey as tgtg_kt
 
-
 class Achievement:
     def __init__(self, title, description, condition_type, condition_value):
         self.title = title
@@ -426,7 +424,7 @@ class PfandCalculator:
         close_button = tk.Button(about_update, text="Close", command=about_update.destroy)
         close_button.grid(row=1, column=0, sticky='ew', padx=10, pady=(0, 10))
     
-    def µScan_credits(self):
+    def µScan_credits(self, about_μScan=None, label_μScan_app=None):
         about_µScan = tk.Toplevel(self.root)
         about_μScan.title("Über µScan")
         about_μScan.geometry("650x190")
diff --git a/README.md b/README.md
index 1b4f566..46599a9 100644
--- a/README.md
+++ b/README.md
@@ -1,46 +1,61 @@
-# ♻️ Pfandrechner
+# ♻️ Pfandrechner – Python Package
 
 **Version:** V.8.04.301-PKG1
-**License:** [MIT](LICENSE)
+**License:**[MIT]()
 
-Welcome to the **Pfandrechner Application - Package** – a sleek and powerful tool for tracking and calculating container deposits ("Pfand") in Austria 🇦🇹. Whether you're returning a few bottles or managing full bags, this app has you covered!
+> ⚠️ **Note:** This package is based on the original [`pfand`](https://github.com/ZockerKatze/pfand) application, which has now been **archived**.
+> This repo (`pfand_PKG`) continues the project in a modular and importable format, ideal for integration into your own Python workflows.
 
-This is a copy of [Pfand](https://github.com/ZockerKatze/pfand), but this is in Package Form which can be **imported** and integrated!
+Welcome to the **Pfandrechner Package** – a modular and importable version of Austria’s beloved container deposit ("Pfand") calculator. This package allows developers to seamlessly integrate Pfand logic into their own Python projects.
 
 ---
 
-## ✨ Features
+## 📦 What’s Inside
 
-🔢 **Deposit Calculator** – Instantly compute the total value of your returned bottles and cans.
+This package retains the core functionalities of the original application, including:
 
-🏆 **Achievements** – Track your progress and unlock fun rewards for your deposit milestones.
-
-📜 **History & Exports** – View your past returns and export the data for safekeeping or bragging rights.
-
-📦 **TGTG Integration** – Check on your "Too Good To Go" orders directly within the app. ( You need to setup your API Key first! )
-
-⚙️ **Smart Updater** – Keeps the app fresh with the latest features and fixes.
+* 🔢 **Deposit Calculator** – Compute the total value of returned bottles and cans.
+* 🏆 **Achievements** – Monitor progress and unlock rewards for deposit milestones.
+* 📜 **History & Exports** – Access past returns and export data.
+* 📦 **TGTG Integration** – Connect with "Too Good To Go" orders (API key setup required).
+* ⚙️ **Smart Updater** – Ensure the package stays updated with the latest features and fixes.
 
 ---
 
-## 🚀 Getting Started
+## 🚀 Installation
 
 ### 1. Clone the Repository
 
 ```bash
 git clone https://github.com/ZockerKatze/pfand_PKG.git
-cd pfand
+cd pfand_PKG
 ```
 
-### 2. Install Dependencies
+### 2. Create and Activate a Virtual Environment (Recommended)
 
-Make sure you’re using Python 3, then run:
+#### On macOS/Linux:
+
+```bash
+python3 -m venv venv
+source venv/bin/activate
+```
+
+#### On Windows:
+
+```bash
+python -m venv venv
+venv\Scripts\activate
+```
+
+### 3. Install Dependencies
 
 ```bash
 pip install -r requirements.txt
 ```
 
-### 3. Launch the App
+### 4. Launch or Integrate
+
+You can now use the package by importing it into your own Python projects, or run the provided entry script if applicable:
 
 ```bash
 python run.py
@@ -48,26 +63,29 @@ python run.py
 
 ---
 
-## 🧮 How to Count
+## 🧮 Usage
 
-You can either:
+You have two options for counting:
 
-- ✍️ **Manually** count and enter your container numbers  
-  _OR_  
-- 🔬 Use **µScan** – the improved scanner for fast and accurate counting with barcode recognition using _pyzbar_!
+* ✍️ **Manual Entry** – Input container numbers directly.
+* 🔬 **µScan** – Utilize the enhanced scanner with barcode recognition powered by `pyzbar`.
 
 ---
 
 ## 🤝 Contributing
 
-Want to improve the app or add new features? Awesome!  
-Fork the repo, make your changes, and send a pull request. 💡
+Contributions are welcome! To contribute:
+
+1. Fork the repository.
+2. Create a new branch for your feature or bugfix.
+3. Commit your changes.
+4. Submit a pull request for review.
 
 ---
 
 ## 📄 License
 
-This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+This project is licensed under the MIT License. See the [LICENSE]() file for details.
 
 ---