Skip to content

Commit 6d94408

Browse files
committed
Changes for ug add
1 parent 46dc57b commit 6d94408

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

docs/UserGuide.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,6 @@ track of multiple items, OneShelf is for you!
4242

4343
--------------------------------------------------------------------------------------------------------------------
4444

45-
46-
4745
## Features
4846

4947
<div markdown="block" class="alert alert-info">
@@ -85,22 +83,29 @@ Alternatives:
8583
![Help Summary Screenshot](images/HelpSummaryWindow.png)
8684

8785

88-
### Adding an item: `add-i`
86+
### Adding an item: `add-i` or `add-d`
8987

90-
Adds item to OneShelf, if there's already an item inside with the same name and supplier, it adds on to existing
91-
quantity of existing item.
88+
Adds inventory item or pending delivery to OneShelf.
9289

9390
Format: `add-i n/NAME q/QUANTITY [s/SUPPLIER] [max/MAX_QUANTITY] [t/TAG]...​`
91+
* Adds `QUANTITY` from the current quantity of an inventory item if the item already exist.
92+
An item is uniquely identified by its NAME and SUPPLIER.
9493

95-
<div markdown="span" class="alert alert-primary">:bulb: **Tip:**
96-
A item can have any number of tags (including 0)
97-
</div>
94+
Examples: `add-i n/CHICKEN q/10 s/NTUC max/50`
9895

99-
### Adding a delivery: `add-d`
96+
Assuming that your inventory item is empty, entering the above command would add a new chicken item that was previously purchased from NTUC. <br>
97+
By entering `add-i n/CHICKEN q/10 max/50`, a new inventory item would be added instead of increasing the quantity since the second chicken has no supplier. <br>
98+
On the other hand, by entering `add-i n/CHICKEN q/10 s/NTUC` again would increase the quantity of Chicken from NTUC to be 20kg.
10099

101-
Adds delivery to OneShelf
102100

103-
Format: `add-d n/NAME, p/PHONE, a/ADDRESS, o/ORDER`
101+
Format: `add-d n/NAME p/PHONE a/ADDRESS o/ORDER`
102+
103+
Examples: `add-d n/DAMITH p/91111111 a/Blk 251 Orchard Road o/Nasi goreng x1`
104+
105+
<div markdown="span" class="alert alert-primary">:bulb: **Tip:**
106+
* An item can have any number of tags (including 0)
107+
* Unlike inventory item, pending delivery does not have a quantity.
108+
</div>
104109

105110
### Removing quantity from an item: `remove-i`
106111

0 commit comments

Comments
 (0)