Merge pull request nus-cs2103-AY2021S1#75

Update UserGuide - Add feature

Author: tohyuting

docs/DeveloperGuide.md

@@ -269,7 +269,8 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
 
 ### Use cases
 
-(For all use cases below, the **System** is the `AddressBook` and the **Actor** is the `user`, unless specified otherwise)
+(For all use cases below, the **System** is the `CLI-nic` and the **Actor** is the `user`, unless specified
+ otherwise)
 
 **Use case: Delete a person**
 
@@ -294,6 +295,66 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
 
       Use case resumes at step 2.
 
+Use case: Add a supplier
+
+MSS
+
+1. User keys in command to add a supplier
+
+2. CLI-nic shows an updated list of suppliers
+
+Use case ends.
+
+Extensions
+
+1a. CLI-nic detects an error in the entered data.
+
+1a1. CLI-nic shows an error message.
+1a2. CLI-nic requests for the correct data.
+1a3. User enters new data
+Steps 1a1-1a3 are repeated until the data entered are correct.
+Use case resumes from step 1.
+
+Use case: Add a store
+
+MSS
+
+1. User keys in command to add a store
+
+2. CLI-nic shows an updated list of stores
+
+Use case ends.
+
+Extensions
+
+1a. CLI-nic detects an error in the entered data.
+
+1a1. CLI-nic shows an error message.
+1a2. CLI-nic requests for the correct data.
+1a3. User enters new data
+Steps 1a1-1a3 are repeated until the data entered are correct.
+Use case resumes from step 1.
+
+Use case: Add a product
+
+MSS
+
+1. User keys in command to add a product
+
+2. CLI-nic shows an updated list of products
+
+Use case ends.
+
+Extensions
+
+1a. CLI-nic detects an error in the entered data.
+
+1a1. CLI-nic shows an error message.
+1a2. CLI-nic requests for the correct data.
+1a3. User enters new data
+Steps 1a1-1a3 are repeated until the data entered are correct.
+Use case resumes from step 1.
+
 *{More to be added}*
 
 ### Non-Functional Requirements

docs/UserGuide.md

@@ -17,7 +17,7 @@ and efficient Graphical User Interface interaction.
 
 1. Ensure you have Java `11` or above installed in your Computer.
 
-1. Download the latest `addressbook.jar` from [here](https://github.com/se-edu/addressbook-level3/releases).
+1. Download the latest `CLInic.jar` from [here](https://github.com/AY2021S1-CS2103-W14-4/tp/releases).
 
 1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook.
 
@@ -27,17 +27,29 @@ and efficient Graphical User Interface interaction.
 1. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will display instructions on various commands.<br>
    Some example commands you can try:
 
-   * **`view supplier supplierA`** : Displays all the information associated with supplierA e.g. address, contact, email, products sold by the supplier etc.
-
-   * **`add`**` p/PANADOL SUSP id/1 t/FEVER` : Adds product named `PANADOL SUSP` with product id of 1 with a `FEVER` tag to CLI-nic.
+   * **`add`** `w/warehouseA addr/John street, block 123, #01-01 wn/First warehouse` : Adds a warehouse
+    with the name warehouseA located at John street, block 123, #01-01. The warehouse is noted to be the “First warehouse”.
+   
+   * **`add`**` s/Philips Pharmaceutical p/00000000 e/philipsPharm@gmail.com sn/largest contractor` : Adds a
+    supplier named Philips Pharmaceutical. His contact number is 00000000 and his email is
+    philipsPharm@gmail.com. The supplier is noted to be the “largest contractor”.
+   
+   * **`add`**` s/SupplierA p/PANADOL SUSP t/FEVER` : Adds the product PANADOL SUSP to list of products from
+    supplierA. This indicates that supplierA is selling this product. PANADOL SUSP also has a tag of FEVER.
+    
+   * **`clear`** : Deletes all contacts.
 
    * **`delete`**` delete supplier 12` : Removes supplier at index 12 from the list of suppliers.
 
-   * **`clear`** : Deletes all contacts.
-
    * **`exit`** : Exits the app.
 
-   * **`find PANADOL warehouse`** : Displays all the warehouses managed by the manager that has a product named PANADOL. 
+   * **`find`**` PANADOL warehouse`** : Displays all the warehouses managed by the manager that has a product
+    named PANADOL.
+
+   * **`update`**` w/WarehouseA p/Panadol q/10` : Updates the quantity of Panadol in WarehouseA to 10. The
+    quantity of Panadol in WarehouseA can be more than 10 or lesser than 10 before the update is done.
+
+   * **`view supplier supplierA`** : Displays all the information associated with supplierA e.g. address, contact, email, products sold by the supplier etc.
 
 
 1. Refer to the [Features](#features) below for details of each command.
@@ -77,29 +89,46 @@ Examples:
 * `help`  Display entire list of commands and their description
 * `help add` Displays the detailed description, input format and an input example of add command.
 
-### Adding a person: `add`
+### Adding a warehouse : `add`
 
-Adds a person to the address book.
+Adds warehouse to the CLI-nic application.
 
-Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​`
+Format: `add w/WAREHOUSE_NAME addr/ADDRESS [wn/WAREHOUSE_NOTE]`
 
-<div markdown="span" class="alert alert-primary">:bulb: **Tip:**
-A person can have any number of tags (including 0)
-</div>
+Examples:
+* `add w/warehouseA addr/John street, block 123, #01-01 wn/First warehouse` : Adds a warehouse with the name
+ warehouseA located at John street, block 123, #01-01. The warehouse is noted to be the “First warehouse”.
+
+### Adding a supplier : `add`
+
+Adds a supplier to the CLI-nic application.
+
+Format: `add s/SUPPLIER_NAME p/CONTACT_NUMBER [e/EMAIL_ADDRESS] [sn/SUPPLIER_NOTE]`
 
 Examples:
-* `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01`
-* `add n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Prison p/1234567 t/criminal`
+* `add s/Philips Pharmaceutical p/00000000 e/philipsPharm@gmail.com sn/largest contractor` : Adds a
+ supplier named Philips Pharmaceutical. His contact number is 00000000 and his email is philipsPharm@gmail.com. The supplier is noted to be the “largest contractor”.
 
-### **Creating a purchase order : `create`**
-* Create a purchase order to track the purchase of medical products from a supplier to a store.
-* **Format**: `create sid/SUPPLIER_ID s/STORE_ID id/PRODUCT_ID…​ qty/PRODUCT_QUANTITY…​ date/EXPECTED_DELIVERED_DATE`		
-    * The number specified for PRODUCT_ID cannot exceed the total number of products. All the IDs must be identifiable
-    * The number of arguments specified for PRODUCT_QUANTITY and PRODUCT_ID must match
-    * EXPECTED_DELIVERED_DATE must be after current time and of the form YYYY-MM-DD
+### Adding a product to a supplier : `add`
 
-* **Examples**: 
-    * `create sid/01 s/123 id/1 2 4 8 qty/100 200 400 800 date/2020-12-12` : Creates a purchase order for the delivery of 100, 200, 400 and 800 of products with ID 1, 2, 4 and 8 respectively from supplier ID of 01 to store ID of 123 by December 12, 2020.
+Adds product information to a supplier; associates a particular product with the supplier in the CLI-nic application.
+
+Format: `add s/SUPPLIER_NAME p/PRODUCT_NAME [t/TAG...]`
+
+Examples:
+* `add s/SupplierA p/PANADOL SUSP t/FEVER` : Adds the product PANADOL SUSP to list of products from supplierA.
+* This indicates that supplierA is selling this product. PANADOL SUSP also has a tag of FEVER.
+
+### Update the stock for a product: `update`
+
+* If the product does not exist for that store, it will associate the new product with the store and the
+* input quantity. Otherwise, it will update the stock of the existing product with the new quantity.
+
+Format:	`update w/WAREHOUSE_NAME p/PRODUCT_NAME q/QUANTITY`
+
+Example:
+* `update w/WarehouseA p/Panadol q/10` : Updates the quantity of Panadol in WarehouseA to 10. The
+* quantity of Panadol in WarehouseA can be more than 10 or lesser than 10 before the update is done.
 
 ### View a specific supplier / warehouse: `view`
 
@@ -158,6 +187,18 @@ CLI-nic data are saved in the hard disk automatically after any command that cha
 
 <br />
 
+### To be implemented in the future
+
+### **Creating a purchase order : `create`**
+* Create a purchase order to track the purchase of medical products from a supplier to a store.
+* **Format**: `create sid/SUPPLIER_ID s/STORE_ID id/PRODUCT_ID…​ qty/PRODUCT_QUANTITY…​ date/EXPECTED_DELIVERED_DATE`		
+    * The number specified for PRODUCT_ID cannot exceed the total number of products. All the IDs must be identifiable
+    * The number of arguments specified for PRODUCT_QUANTITY and PRODUCT_ID must match
+    * EXPECTED_DELIVERED_DATE must be after current time and of the form YYYY-MM-DD
+
+* **Examples**: 
+    * `create sid/01 s/123 id/1 2 4 8 qty/100 200 400 800 date/2020-12-12` : Creates a purchase order for the delivery of 100, 200, 400 and 800 of products with ID 1, 2, 4 and 8 respectively from supplier ID of 01 to store ID of 123 by December 12, 2020.
+
 --------------------------------------------------------------------------------------------------------------------
 
 ## FAQ
@@ -171,11 +212,12 @@ CLI-nic data are saved in the hard disk automatically after any command that cha
 
 Action | Format, Examples
 --------|------------------
-**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​` <br> e.g., `add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 t/friend t/colleague`
-**Create** | `create sid/SUPPLIER_ID s/STORE_ID id/PRODUCT_ID…​ qty/PRODUCT_QUANTITY…​ date/EXPECTED_DELIVERED_DATE`
+**Add** Warehouse | `add w/WAREHOUSE_NAME addr/ADDRESS [wn/WAREHOUSE_NOTE]`<br> e.g., `add w/warehouseA addr/John street, block 123, #01-01 wn/First warehouse`
+**Add** Supplier | `add s/SUPPLIER_NAME p/CONTACT_NUMBER [e/EMAIL_ADDRESS] [sn/SUPPLIER_NOTE]`<br> e.g., `add s/Philips Pharmaceutical p/00000000 e/philipsPharm@gmail.com sn/largest contractor`
+**Add** Product | `add s/SUPPLIER_NAME p/PRODUCT_NAME [t/TAG...]`<br> e.g., `add s/SupplierA p/PANADOL SUSP t/FEVER`
 **Clear** | `clear`
 **Delete** | `delete INDEX`<br> e.g., `delete 3`
-**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`<br> e.g.,`edit 2 n/James Lee e/jameslee@example.com`
 **Find** | `find TYPE KEYWORD`<br> e.g. `find product panadol`
-**List** | `list`
 **Help** | `help`
+**Update** | `update w/WAREHOUSE_NAME p/PRODUCT_NAME q/QUANTITY` <br> e.g., `update w/WarehouseA p/Panadol q/10`
+**View** | `view TYPE NAME`<br> e.g. `view supplier supplierA`