Merge pull request nus-cs2103-AY2021S1#83 from Criss-Wang/master

Fix badge bug

Author: qlchan24

docs/AboutUs.md

@@ -59,8 +59,8 @@ checking on LoC contributions and milestones management
 [[github](http://github.com/Criss-Wang)]
 [[portfolio](team/wangZhenlin.md)]
 
-* Role: Communication/progress manager; Tech Helper; 
-* Responsibilities: 
+* Role: Communication/progress manager; Tech Helper;
+* Responsibilities:
     * In charge of `Delete` command.
     * In charge of team communication (Setup channel/meeting schedule/deal with emergency situation).
     * Track and manage team progression.

docs/DeveloperGuide.md

@@ -19,39 +19,38 @@ and efficient Graphical User Interface interaction.
 
 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.
+1. Copy the file to the folder you want to use as the _home folder_ for your CLI-nic system.
 
 1. Double-click the file to start the app. The 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 display instructions on various commands.<br>
    Some example commands you can try:
 
-   * **`add`** `w/warehouseA addr/John street, block 123, #01-01 wn/First warehouse` : Adds a warehouse
+   * **`add`** `w/warehouseA p/00000000 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
+
+   * **`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
+
+   * **`add`** `s/SupplierA pd/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.
+   * **`delete`** `delete supplier 12` : Removes supplier at index 12 from the list of suppliers.
 
    * **`exit`** : Exits the app.
 
-   * **`find`**` PANADOL warehouse`** : Displays all the warehouses managed by the manager that has a product
+   * **`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.
+   * **`update`** `w/WarehouseA pd/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.
 
 --------------------------------------------------------------------------------------------------------------------
@@ -63,16 +62,16 @@ and efficient Graphical User Interface interaction.
 **:information_source: Notes about the command format:**<br>
 
 * Words in `UPPER_CASE` are the parameters to be supplied by the user.<br>
-  e.g. in `list TYPE`, `TYPE` is a parameter which can be used as `list products`.
+  e.g. in `delete TYPE INDEX`, `TYPE` is a parameter which can be used as `delete warehouse 1`.
 
 * Items in square brackets are optional.<br>
-  e.g `[LIST_TYPE] INDEX` can be used as `delete store 12` or as `delete 1`.
+  e.g `add s/SUPPLIER_NAME p/CONTACT_NUMBER [e/EMAIL_ADDRESS]` can be used as `add s/Philips Pharmaceutical p/00000000 e/philipsPharm@gmail.com` or as `add s/Philips Pharmaceutical p/00000000`.
 
 * Items with `…`​ after them can be used multiple times.<br>
   e.g. `[t/TAG]…​` can be used as `t/friend`, `t/friend t/family` etc.
 
 * Parameters can be in any order.<br>
-  e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable.
+  e.g. if the command specifies `n/NAME p/CONTACT_NUMBER`, `p/CONTACT_NUMBER n/NAME` is also acceptable.
 
 </div>
 
@@ -86,18 +85,20 @@ Narrows down to a specific command and its actual input format and samples if sp
 Format: `help [COMMAND]`
 
 Examples:
-* `help`  Display entire list of commands and their description
+
+* `help`  Display entire list of `COMMAND` and their description.
 * `help add` Displays the detailed description, input format and an input example of add command.
 
 ### Adding a warehouse : `add`
 
 Adds warehouse to the CLI-nic application.
 
-Format: `add w/WAREHOUSE_NAME addr/ADDRESS [wn/WAREHOUSE_NOTE]`
+Format: `add w/WAREHOUSE_NAME p/CONTACT_NUMBER addr/ADDRESS [wn/WAREHOUSE_NOTE]`
 
 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”.
+
+* `add w/warehouseA p/00000000 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's contact number is 00000000. The warehouse is noted to be the “First warehouse”.
 
 ### Adding a supplier : `add`
 
@@ -106,74 +107,78 @@ Adds a supplier to the CLI-nic application.
 Format: `add s/SUPPLIER_NAME p/CONTACT_NUMBER [e/EMAIL_ADDRESS] [sn/SUPPLIER_NOTE]`
 
 Examples:
-* `add s/Philips Pharmaceutical p/00000000 e/philipsPharm@gmail.com sn/largest contractor` : Adds a
+
+* `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”.
 
 ### Adding a product to a supplier : `add`
 
 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...]`
+Format: `add s/SUPPLIER_NAME pd/PRODUCT_NAME [t/TAG…​]`
 
 Examples:
-* `add s/SupplierA p/PANADOL SUSP t/FEVER` : Adds the product PANADOL SUSP to list of products from supplierA.
+
+* `add s/SupplierA pd/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`
+### Clearing all entries : `clear`
 
-* 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.
+Clears all entries (Suppliers and Warehouses) from the CLI-nic.
 
-Format:	`update w/WAREHOUSE_NAME p/PRODUCT_NAME q/QUANTITY`
+Format: `clear`
 
-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.
+### Deletes a particular warehouse or supplier : `delete`
 
-### View a specific supplier / warehouse: `view`
+Delete entries of warehouses or suppliers that are not needed anymore.
 
-Shows a particular supplier/warehouse with their relevant information e.g. products associated with the supplier/warehouse, address etc.
+Format: `delete TYPE INDEX`
 
-Format: `view TYPE NAME`
-* The TYPE specified should be one of these values: supplier or warehouse
-* NAME specified is case-insensitive
+* The TYPE specified should be one of these values: warehouse / supplier.
+* The INDEX must be a positive integer, not exceeding the total number of items.
 
 Examples:
-* `view supplier supplierA` Displays all the information associated with supplierA e.g. address, contact, email, products sold by the supplier etc.
-* `view warehouse warehouseB` Displays all the information associated with warehouseB e.g. address, all the products stored in the warehouse etc. 
+
+* `delete warehouse 1` Removes the warehouse at index 1.
+* `delete supplier 12` Removes supplier at index 12 from the list of suppliers.
 
 ### Finding medical product associated with warehouses / suppliers: `find`
 
 Finds all suppliers or warehouses managed by the manager that sells the relevant medical products.
 
-Format: `find PRODUCT TYPE`
+Format: `find TYPE KEYWORD…​`
 
-* PRODUCT and KEYWORD specified is case-insensitive.
-* The TYPE specified should be one of these values: warehouse / supplier
+* KEYWORD specified is case-insensitive.
+* The TYPE specified should be one of these values: warehouse / supplier.
 
 Examples:
-* `find PANADOL warehouse` displays all the warehouses managed by the manager that has a product named PANADOL. 
-* `find masks supplier` displays all the suppliers that have stock for the input product.	
 
-### Deletes a particular warehouse or supplier : `delete`
+* `find warehouse PANADOL SUSP` Displays all the warehouses managed by the manager that has a product named PANADOL SUSP.
+* `find supplier masks` Displays all the suppliers that have stock for the input product.
 
-Delete entries of warehouses or suppliers that are not needed anymore.
+### View a specific supplier / warehouse: `view`
 
-**Format**: `delete TYPE INDEX`
+Shows a particular supplier/warehouse with their relevant information e.g. products associated with the supplier/warehouse, address etc.
 
-* The TYPE specified should be one of these values: warehouse / supplier.
-* The INDEX must be a positive integer, not exceeding the total number of items.
+Format: `view TYPE NAME`
 
-**Examples**
+* The TYPE specified should be one of these values: supplier or warehouse.
+* The supplier/warehouse NAME specified is case-insensitive.
 
-* `delete warehouse 1` Removes the warehouse at index 1.
-* `delete supplier 12` Removes supplier at index 12 from the list of suppliers.
+Examples:
 
-### Clearing all entries : `clear`
+* `view supplier supplierA` Displays all the information associated with supplierA e.g. address, contact, email, products sold by the supplier etc.
+* `view warehouse warehouseB` Displays all the information associated with warehouseB e.g. address, all the products stored in the warehouse etc.
 
-Clears all entries (Suppliers and Warehouses) from the CLI-nic.
+### Update the stock for a product: `update`
 
-Format: `clear`
+* If the product does not exist for that warehouse, it will associate the new product with the warehouse and the input quantity. Otherwise, it will update the stock of the existing product with the new quantity.
+
+Format:	`update w/WAREHOUSE_NAME pd/PRODUCT_NAME q/QUANTITY`
+
+Example:
+
+* `update w/WarehouseA pd/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.
 
 ### Exiting the program : `exit`
 
@@ -187,17 +192,22 @@ CLI-nic data are saved in the hard disk automatically after any command that cha
 
 <br />
 
-### To be implemented in the future
+--------------------------------------------------------------------------------------------------------------------
+
+## To be implemented in the future
+
+### Creating a purchase order : `create`
+Creates a purchase order to track the purchase of medical products from a supplier to a warehouse.
 
-### **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
+Format: `create s/SUPPLIER_NAME w/WAREHOUSE_NAME pd/PRODUCT_NAME…​ qty/PRODUCT_QUANTITY…​ date/EXPECTED_DELIVERED_DATE`
+
+* All the SUPPLIER_NAME/WAREHOUSE_NAME/PRODUCT_NAME must be identifiable.
+* The number of arguments specified for PRODUCT_QUANTITY and PRODUCT_NAME must match.
+* EXPECTED_DELIVERED_DATE must be after current time and of the form YYYY-MM-DD.
+
+Examples:
 
-* **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.
+* `create s/SupplierA w/WarehouseA pd/Panadol1 Panadol2 qty/100 200 date/2020-12-12` Creates a purchase order for the delivery of 100, 200 of products Panadol1 & Panadol2 respectively from SupplierA to WarehouseA by December 12, 2020.
 
 --------------------------------------------------------------------------------------------------------------------
 
@@ -212,12 +222,12 @@ CLI-nic data are saved in the hard disk automatically after any command that cha
 
 Action | Format, Examples
 --------|------------------
-**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** Warehouse | `add w/WAREHOUSE_NAME p/CONTACT_NUMBER addr/ADDRESS [wn/WAREHOUSE_NOTE]`<br> e.g., `add w/warehouseA p/00000000 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`
+**Add** Product | `add s/SUPPLIER_NAME pd/PRODUCT_NAME [t/TAG…​]`<br> e.g., `add s/SupplierA pd/PANADOL SUSP t/FEVER`
 **Clear** | `clear`
-**Delete** | `delete INDEX`<br> e.g., `delete 3`
-**Find** | `find TYPE KEYWORD`<br> e.g. `find product panadol`
+**Delete** | `delete TYPE INDEX`<br> e.g., `delete 3`
+**Find** | `find TYPE KEYWORD…​`<br> e.g. `find warehouse panadol`
 **Help** | `help`
-**Update** | `update w/WAREHOUSE_NAME p/PRODUCT_NAME q/QUANTITY` <br> e.g., `update w/WarehouseA p/Panadol q/10`
+**Update** | `update w/WAREHOUSE_NAME pd/PRODUCT_NAME q/QUANTITY` <br> e.g., `update w/WarehouseA pd/Panadol q/10`
 **View** | `view TYPE NAME`<br> e.g. `view supplier supplierA`

docs/UserGuide.md

@@ -3,8 +3,8 @@ layout: page
 title: CLI-nic
 ---
 
-[![CI Status](https://github.com/Y2021S1-CS2103-W14-4/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2021S1-CS2103-W14-4/tp/actions)
-[![codecov](https://codecov.io/gh/Y2021S1-CS2103-W14-4/tp/branch/master/graph/badge.svg)](https://codecov.io/gh/AY2021S1-CS2103-W14-4/tp)
+[![CI Status](https://github.com/AY2021S1-CS2103-W14-4/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2021S1-CS2103-W14-4/tp/actions)
+[![codecov](https://codecov.io/gh/AY2021S1-CS2103-W14-4/tp/branch/master/graph/badge.svg)](https://codecov.io/gh/AY2021S1-CS2103-W14-4/tp)
 
 ![Ui](images/Ui.png)
 

docs/images/Ui.png

@@ -31,4 +31,3 @@ It is written in Java, and has about 10 kLoC.
 
 * **Tools**:
   * nil
-

docs/index.md

@@ -17,11 +17,11 @@ Given below are my contributions to the project.
   * Highlights: This command will allow for future features with regard to inventory management and sales metrics
   * Credits: *{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}*
 
-* **New Feature**: 
+* **New Feature**:
 
 * **Code contributed**: [RepoSense link]()
 
-* **Project management**: 
+* **Project management**:
 
 * **Enhancements to existing features**:
 

docs/team/jeffrey.md

@@ -5,10 +5,9 @@ title: Wang Zhenlin's Project Portfolio Page
 
 ## Project: CLI-nic
 
-CLI-nic is **an application to help medical supply managers keep track of medical products and storage.** It is optimized
-for these managers to **update product supply conditions and access critical product information quickly** via fast typing
-and efficient Graphical User Interface interaction.
-It is written in Java, and has about __ kLoC.
+CLI-nic is **a desktop application to help medical product sales managers keep track of medical products and storage**.
+It is optimized for these managers to **update product conditions and access critical product information quickly via fast typing**.
+It is written in Java, and has about 10 kLoC.
 
 Given below are my contributions to the project.
 
@@ -21,7 +20,7 @@ Given below are my contributions to the project.
   * Credits: {mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}
 
 * **Project management**:
-  * Managed releases `v1.3` - `v1.5rc` (_ releases) on GitHub
+  * Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub
 
 * **Enhancements to existing features**:
   * Updated the GUI (Pull requests [\#33](), [\#34]())
@@ -47,5 +46,3 @@ Given below are my contributions to the project.
 
 * **Tools**:
   * nil
-
-