From b34e01e16ccec99746d6424f51bda03c6b2dea35 Mon Sep 17 00:00:00 2001
From: stesiam <52320488+stesiam@users.noreply.github.com>
Date: Mon, 22 Apr 2024 17:54:08 +0300
Subject: [PATCH] Update README.md
---
README.md | 29 +++++++++++++++++++++++++----
1 file changed, 25 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 90a8771..774c255 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,31 @@
-# Greek Elections App v2
+# 🗳️ Greek Elections App v2
[![Docker Image CI](https://github.com/stesiam/Greek-Elections-App/actions/workflows/docker-image.yml/badge.svg)](https://github.com/stesiam/Greek-Elections-App/actions/workflows/docker-image.yml)
-A Shiny App that calculates the seats of each party in the Greek Parliament.
+[Shiny App Website](https://stesiam.shinyapps.io/Greek-Elections-App/)
-You can calculate the seats of the parties based on their percentage for the last 4 electoral laws.
+A Shiny App that calculates the seats of each party in the Greek Parliament. You can calculate the seats of the parties based on their percentage for the last four electoral laws. Below, I enumerate those, and in parentheses are the elections for which they have been in effect:
+|Electoral Law| Elections| Description |
+|:---:|:---:|---|
+|**Bonus 40**| 2007
2009|260 🪑 are being allocated proportionally
First party + 40 🪑
Electoral threshold: 3% |
+|**Bonus 50**| 2012
2015
2019|250 🪑 are being allocated proportionally
First party + 50 🪑
Electoral threshold: 3% |
+|**No Bonus**| 2023A |300 🪑 are being allocated proportionally
No bonus 🪑
Electoral threshold: 3% |
+|**Proportional Bonus**| 2023B | Varied seats (260 to 300) are being allocated proportionally
Depends on first party percentage
Electoral threshold: 3% |
+
+
+Proportional Bonus has been set as the default electoral system as this is the current system from 2023B and onwards.
+
+## Implemented Features
+
+- Multilanguage ( 🇬🇷 / 🇬🇧 ) - [{shiny.i18n}](https://github.com/Appsilon/shiny.i18n)
+- DaisyUI Table style - [{shiny.tailwind}](https://github.com/kylebutts/shiny.tailwind)
+- Cookies to save language selection - [{cookies}](https://github.com/shinyworks/cookies) R package
+
+## Future Plans
+
+- Add unallocated percenage in app (make it red if it goes negative)
+- A popup window at start which will explain the electoral system on Greece
+- A cookie for electoral system
+- UNDER CONDITIONS a cookie for parties' percentages (I should also give a reset button as an option)
-[Shiny App Website](https://stesiam.shinyapps.io/Greek-Elections-App/)