From d631ac1bd1c1b157f2afcff49cbfb3dd94abf314 Mon Sep 17 00:00:00 2001
From: Lim Zi Jia <62246275+LimZiJia@users.noreply.github.com>
Date: Tue, 26 Mar 2024 00:06:08 +0800
Subject: [PATCH] Update README.md
---
README.md | 47 +++++++++++++++++++++++++++++++++++------------
1 file changed, 35 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
index 09d1802..f50a9bb 100644
--- a/README.md
+++ b/README.md
@@ -1,30 +1,53 @@
+# Transaction Balancer
+If you have a group that takes turns to pay and split the bill later, this is the program for you!
+You can add a transactions to the program everytime someone pays and balancing the payments is as easy as typing `calculate`.
+Also, don't worry about entering every transaction in one session because it is automatically saved for you!
+
+## Features
+* Add as many transactions as you want! They will be aggregated per person automatically.
+* Every `add` and `delete` automatically saves your transaction list.
+* Saved transaction list is loaded automatically on start up.
+* You can `list` all transactions to view the current transaction list.
+* delete all!` is useful to reset the program for next time.
+
+
# Setup
-1. Download the latest release from ![]()
-2. Move the `.jar` file to your desired directory
-3. `cd` your terminal into the directory containing your `.jar` file
-4. Run the application by typing `java -jar filename.jar` into th teterminal
+1. Make sure you have Java 11 or above installed in your computer
+2. Download the latest ![release]()
+3. Move the `.jar` file to your desired directory
+4. `cd` your terminal into the directory containing your `.jar` file
+5. Run the application by typing `java -jar filename.jar` into th teterminal
# Commands
For the command formats below, lower cases are the keywords and CAPS are the user inputs.
### `add`
-Format: `add NAME AMOUNT`
The add commands adds a transaction that NAME has made during the trip.
-TIP: If the input is wrong, you can either use the `delete` command or `add NAME -AMOUNT` to correct it. You can also check the list of transactions using the `list` command.
+
+Format: `add NAME AMOUNT`
+
+**TIP:** If the input is wrong, you can either use the `delete` command and `add NAME AMOUNT` again, or `add NAME -AMOUNT` to correct it. You can also check the list of transactions using the `list` command.
### `list`
-Format: `list`
-Prints list of transactions. Each person's contribution will be aggregated.
+Prints list of transactions. Each person's contribution will be aggregated.
+
+Format: `list`
### `delete`
-Format: `delete NAME`
-Deletes entries in the transaction table with NAME.
+Deletes entries in the transaction table with NAME.
+Deletes all enties if argument is `all!`
+
+Format: `delete NAME` or `delete all!`
### `calculate`
+Prints out the final list of (the minimum number of) transactions that are required to resolve the balancing of funds.
+
Format: `calcuate`
-Prints out the final list of (the minimum number of) transactions that are required to resolve the balancing of funds.
+
NOTE: If somebody did not contribute anything throughout the trip, do `add NAME 0` to include him/her into the calculation.
+Similarly, if somebody should not be included in the final transaction, they should not have an entry in the transactions list. Do `delete NAME` to remove them.
### `exit`
+Exits the program
+
Format: `exit`
-Exits the program