Merge pull request #85 from whitesnowx/updateUserGuideSort

Update UserGuide to include Sort 📁

docs/UserGuide.md

@@ -5,37 +5,37 @@ title: User Guide
 
 StaffConnect (SC) is a **desktop app for managing contacts of Professors and Tutors, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, SC can get your contact management tasks done faster than traditional GUI apps.
 
-* Table of Contents
+* Table of Contents 
 {:toc}
 
 --------------------------------------------------------------------------------------------------------------------
 
 ## Quick start
 
-1. Ensure you have Java `11` or above installed in your Computer.
+1. Ensure you have Java `11` or above installed in your Computer. 
 
-1. Download the latest `StaffConnect.jar` from [here](https://github.com/AY2324S2-CS2103-F08-3/tp/).
+2. Download the latest `StaffConnect.jar` from [here](https://github.com/AY2324S2-CS2103-F08-3/tp/).
 
-1. Copy the file to the folder you want to use as the _home folder_ for your StaffConnect application.
+3. Copy the file to the folder you want to use as the _home folder_ for your StaffConnect application.
 
-1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar StaffConnect.jar` command to run the application.<br>
+4. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar StaffConnect.jar` command to run the application.<br>
    A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>
    ![Ui](images/Ui.png)
 
-1. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.<br>
+5. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.<br>
    Some example commands you can try:
 
-   * `list` : Lists all contacts.
+    * `list` : Lists all contacts.
 
-   * `add n/John Doe p/98765432 e/[email protected] v/John street, block 123, #01-01 m/CS2103` : Adds a contact named `John Doe` to the contacts list.
+    * `add n/John Doe p/98765432 e/[email protected] v/John street, block 123, #01-01 m/CS2103` : Adds a contact named `John Doe` to the contacts list.
 
-   * `delete 3` : Deletes the 3rd contact shown in the current list.
+    * `delete 3` : Deletes the 3rd contact shown in the current list.
 
-   * `clear` : Deletes all contacts.
+    * `clear` : Deletes all contacts.
 
-   * `exit` : Exits the app.
+    * `exit` : Exits the app.
 
-1. Refer to the [Features](#features) below for details of each command.
+6. Refer to the [Features](#features) below for details of each command.
 
 --------------------------------------------------------------------------------------------------------------------
 
@@ -130,6 +130,23 @@ Examples:
 * `find alex david` returns `Alex Yeoh`, `David Li`<br>
   ![result for 'find alex david'](images/findAlexDavidResult.png)
 
+### Sorting persons by attribute: `sort`
+
+Sorts the list of persons based on specified attribute.
+
+Format: `sort [ATTRIBUTE]`
+
+* By default, sorting is done in ascending order.
+* The order of character priority would be letters (A-Z), numbers (0-9), special characters (!@#$%^&*).
+* The capitalisation of the letters do not affect their priority such that `Aaron` will have same priority as `aaron`.
+* For attribute with exact same values, the tie-breaker is determined by their added order.
+* `[ATTRIBUTE]` is to be noted by their prefix. e.g `name` will be `n/`.
+
+Examples:
+* `sort n/` returns person by ascending names `Alex`, `Bernice` followed by `Charlotte`
+* `sort p/` returns person by ascending phone numbers `87438807`, `91031282` followed by `92492021`<br>
+  ![result for 'sort p/'](images/sortByPhoneNumberResult.png)
+
 ### Deleting a person : `delete`
 
 Deletes the specified person from the contacts.
@@ -197,5 +214,6 @@ Action | Format, Examples
 **Delete** | `delete INDEX`<br> e.g., `delete 3`
 **Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [v/VENUE] [m/MODULE] [t/TAG]…​ [a/AVAILABILITY]…​`<br> e.g.,`edit 2 n/James Lee e/[email protected]`
 **Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake`
+**Sort** | `sort [ATTRIBUTE]`<br> e.g., `sort p/`
 **List** | `list`
 **Help** | `help`