diff --git a/README.md b/README.md
index f186dda..ac54a61 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,284 @@
-# Help-Me-Help
+# Help-Me-Help - IDATT1005 Team 5 Portfolio Project Spring 2026 :octocat:
+
+**TEAM 5 STUDENT NAMES**
+
+
+
+src/main/java/edu/group5/app/ +βββ App.java (JavaFX Application entry point) +| +βββ control/ (Controllers - business logic) +β βββ AuthController.java (User login/signup handling) +β βββ DonationController.java (Donation processing) +β βββ NavigationController.java (Page navigation) +β βββ OrganizationController.java (Organization data access) +| +βββ model/ (Business entities & repositories) +β βββ organization/ +β β βββ Organization.java (Organization entity) +β β βββ OrganizationRepository.java (Data access for organizations) +β β βββ OrganizationService.java (Business logic) +β β βββ OrganizationScraper.java (Web scraping - descriptions & logos) +β βββ user/ +β β βββ User.java (User base class) +β β βββ Customer.java (Customer implementation) +β β βββ UserRepository.java (Data access for users) +β β βββ UserService.java (User authentication & registration) +β βββ donation/ +β β βββ Donation.java (Donation entity) +β β βββ DonationRepository.java (Data access for donations) +β β βββ DonationService.java (Donation processing) +β βββ wrapper/ +β β βββ DbWrapper.java (H2 database connection & operations) +β β βββ OrgApiWrapper.java (Innsamlingskontrollen API client) +β βββ AppState.java (Global application state) +β βββ Repository.java (Base repository abstract) +β βββ DBRepository.java (Database repository abstract) +| +βββ view/ (JavaFX UI components) +β βββ loginpage/ +β β βββ LoginPageView.java +β β βββ SignUpPageView.java +β β βββ LoginHeader.java +β β βββ loginpage.css +β βββ homepage/ +β β βββ HomePageView.java +β βββ causespage/ +β β βββ CausesPageView.java +β β βββ OrganizationCard.java +β β βββ causespage.css +β βββ organizationpage/ +β β βββ OrganizationPageView.java +β β βββ organizationpage.css +β βββ donationpage/ +β β βββ DonationPageView.java +β β βββ PaymentCompletePageView.java +β β βββ donationpage.css +β βββ userpage/ +β β βββ UserPageView.java +β βββ aboutuspage/ +β β βββ AboutUsView.java +β βββ Header.java +| +βββ utils/ +βββ ParameterValidator.java (Input validation utilities) + +src/main/resources/ (Static assets - CSS, images, etc.) +βββ header/ +β βββ images/ +β βββ hmh-logo.png (Application logo) +βββ loginpage/ +β βββ loginpage.css (Login/signup page styling) +βββ homepage/ +β βββ homepage.css (Home page styling) +βββ causespage/ +β βββ causespage.css (Organization browsing styling) +βββ organizationpage/ +β βββ organizationpage.css (Organization details styling) +βββ donationpage/ + βββ donationpage.css (Donation flow styling) ++ +### π¦ Package Responsibilities + +#### Models: Business logic and data entities + +- `Organization`: Represents a charity/relief organization with status, logo, description +- `User` & `Customer`: User profiles with authentication +- `Donation`: Records of user donations +- Services and Repositories implement the business logic and data access layers + +#### Controller: Bridge between UI and business logic + +- `AuthController`: Handles user login/registration with password hashing (BCrypt) +- `OrganizationController`: Manages organization data retrieval and caching +- `DonationController`: Processes donations and updates user history +- `NavigationController`: Coordinates page navigation + +#### View: JavaFX UI components + +- Login/signup pages with form validation +- Organization browsing with filtering (approved/pending) +- Donation flow with payment confirmation +- User profile and donation history + +#### Utils: Helper functions + +- `ParameterValidator`: Validates null, empty, and positive values + +### JUnit Tests (`src/test`) + +The JUnit tests are stored under `src/test` and mirror the main package structure. These tests cover both positive and negative test of all classes (except `App.java` and UI classes) and their methods ensuring program reliability according to the specification given in the portofolie project descriptions +
+src/test/java/edu/group5/app/ +βββ AppTest.java (Application startup tests) +βββ control/ +β βββ (Controller integration tests - to be added) +βββ model/ +β βββ donation/ +β β βββ DonationRepositoryTest.java (Data access layer tests) +β β βββ DonationServiceTest.java (Business logic tests) +β β βββ DonationTest.java (Entity tests) +β βββ organization/ +β β βββ OrganizationRepositoryTest.java (Data access layer tests) +β β βββ OrganizationScraperTest.java (Web scraping tests - 86% coverage) +β β βββ OrganizationServiceTest.java (Business logic tests) +β β βββ OrganizationTest.java (Entity tests) +β βββ user/ +β β βββ CustomerTest.java (Customer entity tests) +β β βββ UserRepositoryTest.java (Data access layer tests) +β β βββ UserServiceTest.java (Authentication & registration tests) +β βββ wrapper/ +β βββ DbWrapperDonationsTest.java (Database wrapper tests - donations) +β βββ DbWrapperUserTest.java (Database wrapper tests - users) +β βββ OrgApiWrapperTest.java (API client tests) +βββ utils/ +β βββ ParameterValidatorTest.java (Input validation tests) +βββ view/ + βββ ViewTest.java (UI component tests) ++ +### Maven Layout + +The project uses the standard Maven directory structure, which ensures: + +- clean separation of source and test files +- compatibility with IDEs such as IntelliJ, VS Code, and Eclipse +- maintainability and easy future extensions (e.g., persistence or additional views) + +## Link to repositoryπ + +