From cddc1e50405d757de41c7a759ccfbbc117a5a2c8 Mon Sep 17 00:00:00 2001
From: Andrew Trieu <68151686+AndrewTrieu@users.noreply.github.com>
Date: Mon, 19 Dec 2022 22:33:07 +0200
Subject: [PATCH] Update README.md
---
README.md | 19 +++++++++++++++----
1 file changed, 15 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 208e441..a58cbec 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,17 @@
-# Lahden-Talot-Pesulavaraus
-Automated laundry reservation at for Lahden Talot tenants with customization.
+# Laundromatic
+A Python application that automates laundry slot reservation at for Lahden Talot tenants.
-Future implementation: GUI
+
-LIMITATION: The whole week will be skipped if the first chosen laundry slot is taken.
+## Instructions
+1. Enter your username and password
+2. Enter number of weeks to book (including this week)
+3. Choose the slots
+4. Click start
+5. Confirm and wait
+
+## Notes
+- Executable files were created using [PyInstaller](https://pyinstaller.org/).
+- The source code will be cleaned up in the next release. It is very messy and hard to read.
+- The GUI will be updated in the next release. It looks outdated and crude.
+- The executable files were not thoroughly tested on different environments and might not work as intended.