Merge branch 'master' into edit-ug-format

docs/UserGuide.md

@@ -8,14 +8,12 @@ your operations. Within these pages, you'll find detailed coverage of the follow
 - Features
     - User
         - Register
-        - Secure account with a password (?)
         - Login
         - Forget password [Coming Soon]
         - Logout
         - Change password [Coming Soon]
-        - Update details [Coming Soon]
+        - Update user details [Coming Soon]
         - Delete account [Coming Soon]
-        - Recover password (?)
     - Customer
         - Add customer
         - Search for a customer [Coming Soon]
@@ -27,7 +25,7 @@ your operations. Within these pages, you'll find detailed coverage of the follow
         - Create delivery
         - View all deliveries
         - View details of deliveries
-        - Update delivery status and date 
+        - Update delivery status and date
         - Delete delivery
         - Create a note for a delivery [Coming Soon]
         - View deliveries for the day [Coming Soon]
@@ -36,15 +34,11 @@ your operations. Within these pages, you'll find detailed coverage of the follow
         - Look up delivery details [Coming Soon]
 - Troubleshooting / FAQ
 
-#
-
 # Getting Started
 
 To get started, you will need to create an account and download the software. Once you have done that, you can follow
 the instructions in the Getting Started Guide to start using the software.
 
-#
-
 # Features
 
 \*[ ] specifies optional fields
@@ -53,73 +47,75 @@ the instructions in the Getting Started Guide to start using the software.
 
 ### Register
 
-**Format: `register --user USERNAME --password PASSWORD --confirmPass CONFIRM_PASSWORD`**
+**Format:** `register --user USERNAME --password PASSWORD --confirmPass CONFIRM_PASSWORD`
 
-**Example: `register --user gabriel --password gabrielIsGreat --confirmPass gabrielIsGreat`**
+**Example:** `register --user gabriel --password gabrielIsGreat --confirmPass gabrielIsGreat`
 
 **Accepted Values:**
 
 _USERNAME:_ String
 
 _PASSWORD:_ String
 
-_CONFIRM PASSWORD:_ String that is the same as PASSWORD.
+_CONFIRM PASSWORD:_ String that is the same as _PASSWORD_.
 
-**Command succeeds: _Register successful._**
+**Command succeeds:** _Register successful._
 
-**Command fails (missing fields): _Please fill up all the required fields._**
+**Command fails (missing fields):** _Please fill up all the required fields._
 
-**Command fails (password does not match): _Passwords do not match. Try again._**
+**Command fails (password does not match):** _Passwords do not match. Try again._
 
 ### Login
 
-**Format: `login --user USERNAME --password PASSWORD`**
+**Format:** `login --user USERNAME --password PASSWORD`
 
-**Example: `login --user gabriel --password gabrielIsGreat`**
+**Example:** `login --user gabriel --password gabrielIsGreat`
 
 **Accepted Values:**
 
 _USERNAME:_ String
 
 _PASSWORD:_ String
 
-**Command succeeds: _Log in successful._**
+**Command succeeds:** _Log in successful._
 
-**Command fails (missing fields): _Please fill up all the required fields._**
+**Command fails (missing fields):** _Please fill up all the required fields._
 
-**Command fails (wrong login credentials): _Wrong username and/or password. Try again._**
+**Command fails (wrong login credentials):** _Wrong username and/or password. Try again._
 
 ### Forget Password `[Coming Soon in v1.3]`
+
 _Details coming soon..._
 
 ### Logout
 
-**Format: `logout`**
+**Format:** `logout`
 
-**Example: `logout`**
+**Example:** `logout`
 
-**Command succeeds: _Logout successful._**
+**Command succeeds:** _Logout successful._
 
 ### Change Password `[Coming Soon in v1.3]`
+
 _Details coming soon..._
 
 ### Update details `[Coming Soon in v1.3]`
+
 _Details coming soon..._
 
 ### Delete Account `[Coming Soon in v1.3]`
-_Details coming soon..._
 
+_Details coming soon..._
 
 ## <span style="text-decoration:underline;">Customer</span>
 
 ### Add a customer
 
 Adds a customer to the address book.
 
-**Format: `customer add --name NAME --phone PHONE_NUMBER --email EMAIL --address ADDRESS`**
+**Format:** `customer add --name NAME --phone PHONE_NUMBER --email EMAIL --address ADDRESS`
 
-**Example: <code>customer add --name Gabriel --phone 8765 4321**
---email [[email protected]](mailto:[email protected]) --address RVRC Block B</code></strong>
+**Example:** `customer add --name Gabriel --phone 8765 4321 --email [email protected] --address RVRC Block B`
 
 **Accepted Values:**
 
@@ -131,44 +127,47 @@ _EMAIL_: String with @ and . in valid email format
 
 _ADDRESS_: String
 
-**Command succeeds: _Customer 1, Gabriel added._**
+**Command succeeds:** _Customer 1, Gabriel added._
 
-**Command fails (missing field): _Please fill up all the required fields (--name NAME --phone PHONE_NUMBER --email 
-EMAIL --address ADDRESS)._**
+**Command fails (missing field):** _Please fill up all the required fields (--name NAME --phone PHONE_NUMBER --email 
+EMAIL --address ADDRESS)._
 
 ### Search for a customer `[Coming Soon in v1.3]`
+
 _Details coming soon..._
 
 ### List customers
 
 Lists all the customers added in the address book.
 
-**Format**: `customer list`
+**Format:** `customer list`
 
-**Example**: `customer list`
+**Example:** `customer list`
 
 **Accepted Values:**
 
 _NIL_
 
-**Command succeeds (>0 customers):** _Here is the list of customers:_
+**Command succeeds (>0 customers):** 
 
+_Here is the list of customers:_
 1. _Benjamin, Phone: 9898 2323, Email: [email protected], Address: Carnegie Mellon University, South Block._
 2. _Gambe, Phone: 9797 1313, Email: [email protected], Address: Kent Ridge Hall_
 3. _Gabriel, Phone: 9090 9241, Email: [email protected], Address: RVRC Tower Block_
 
 **Command succeeds (0 customer):** _There are no customers added yet!_
 
 ### Sort the list of customers `[Coming Soon in v1.3]`
+
 _Details coming soon..._
 
 ### Update customer details
 
 Updates the personal details of an existing customer in the address book.
 
-**Format**: `customer edit CUSTOMER_ID [--name NAME] [--phone PHONE_NUMBER] [--email EMAIL] [--address ADDRESS]`
+**Format:** `customer edit CUSTOMER_ID [--name NAME] [--phone PHONE_NUMBER] [--email EMAIL] [--address ADDRESS]`
 
-**Example**: `customer edit 1001 --name Gabriel -–phone 1234 5678 --email [email protected] --address RVRC Block B Ben's Room`
+**Example:** `customer edit 1001 --name Gabriel -–phone 1234 5678 --email [email protected] --address RVRC Block B Ben's Room`
 
 **Accepted Values:**
 
@@ -228,16 +227,20 @@ _DELIVERY_NAME:_ String of 50 characters
 
 _CUSTOMER_ID:_ Integer
 
-_DATE:_ YYYY-MM-DD format
+_DATE:_ String in YYYY-MM-DD format
 
 **Command succeeds:** _Delivery [1001] furniture created successfully for Customer 1, Gabriel!_
 
-**Command fails (missing_fields):** _Please fill up all the required fields (--name NAME --id CUSTOMER_ID --date DATE)!_
+**Command fails (missing_fields):** _Please fill up all the required fields (DELIVERY_NAME --customer CUSTOMER_ID --date DATE)!_
 
 **Command fails (invalid_date):** _Invalid date provided!_
 
 **Command fails (invalid_date_format):** _Please provide the date in the format: YYYY-MM-DD._
 
+### Create a note for a delivery `[Coming Soon in v1.3]`
+
+_Details coming soon..._
+
 ### View all deliveries
 
 Shows a list of all deliveries.
@@ -364,10 +367,6 @@ _DELIVERY_ID_: Integer
 
 **Command failed (delivery_id not in database):** _This delivery does not seem to exist!_
 
-### Create a note for a delivery `[Coming Soon in v1.3]`
-
-_Details coming soon..._
-
 ### View deliveries for the day `[Coming Soon in v1.3]`
 
 _Details coming soon..._