Skip to content

Commit 71f7e48

Browse files
committed
Update README and UG
1 parent f9a75fb commit 71f7e48

File tree

2 files changed

+14
-15
lines changed

2 files changed

+14
-15
lines changed

README.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ifndef::env-github[]
1111
image::images/Ui.png[width="600"]
1212
endif::[]
1313

14-
Have you ever lost track of your items' expiry dates and end up throwing the items away? Have you ever open your fridge to search for your favourite chocolate, only to realise that it has already expired? Fret not! Xpire is here to save you! With features to help you keep track of your items' expiry dates as well as to remind you of soon-expiring items, you will never have to face any expired items ever again.
14+
Have you ever lost track of your items' expiry dates and end up throwing the items away? Have you ever open your fridge to search for your favourite chocolate, only to realise that it has already expired? Fret not! Xpire is here to save you! With features to help you keep track of your items' expiry dates as well as to remind you of soon-expiring items, you will never have to worry about when your items are expiring again. Next time, you will be sure to eat that chocolate before it expires!
1515

1616
Interested to try out our application? Head over to the <<UserGuide#, UserGuide>> to get started!
1717

docs/UserGuide.adoc

+13-14
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,9 @@ e.g. typing *`help`* and pressing kbd:[Enter] will open the help window.
4747
====
4848
*Command Format*
4949
50-
* Words that are enclosed with `<` and `>` are the parameters to be supplied by the user e.g. in `add|<item name>|<expiry date>`, `<item name>` and `<expiry date>` are parameters which can be used as `add|banana|25/09/2019`.
51-
* Items in square brackets are optional e.g `add|<item name>|<expiry date>|[#tag]` can be used as `add|strawberry|10/10/2019|#Fruit`.
52-
* Items with `…`​ after them can be used multiple times including zero times e.g. `tag|<index>|#tag...` can be used as `tag|1|#Fruit #Frozen #Cold`, `tag|1`, or `tag|1|#Fruit` etc.
53-
//* Parameters can be in any order e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable.
50+
* Words that are enclosed with `<` and `>` are the parameters to be supplied by the user e.g. in `set reminder|<index>|<threshold>`, `<index>` and `<threshold>` are parameters which can be used as `set reminder|1|7`.
51+
* Parameters in square brackets are optional e.g `check[|<days>]` can be used as `check|7` or `check`.
52+
* Optional parameters with `…`​ after them can be used multiple times including zero times e.g. `tag|<index>|[<tag>]...` can be used as `tag|1|#Fruit #Frozen #Cold`, `tag|1`, or `tag|1|#Fruit`.
5453
====
5554

5655
=== Viewing help : `help`
@@ -60,7 +59,7 @@ Format: `help`
6059
=== Adding an item: `add`
6160

6261
Adds item to list +
63-
Format: `add|<item name>|<expiry date>[|#tag...]`
62+
Format: `add|<item name>|<expiry date>|[<tag>]...`
6463

6564
[TIP]
6665
An item can have any number of tags (including 0)
@@ -102,7 +101,7 @@ Format: `view`
102101
=== Listing expiring items : `check`
103102
104103
Shows expiring items in the list. +
105-
Format: `check|<days>`
104+
Format: `check[|<days>]`
106105
107106
****
108107
* Lists items expiring within the specified number of `<days>`
@@ -117,7 +116,7 @@ Lists items expiring in the next 20 days.
117116
=== Sorting all items : `sort`
118117
119118
Sorts all items in the list by either name or date. +
120-
Format: `sort|<method>`
119+
Format: `sort|<key>`
121120
122121
****
123122
* Sorting by both name and date is done in ascending order.
@@ -133,7 +132,7 @@ Examples:
133132
=== Searching item by name: `search`
134133
135134
Search items whose names contain any of the given keywords. +
136-
Format: `search|<keyword>|[other keywords...]`
135+
Format: `search|<keyword>[|<other keywords>]...`
137136
138137
****
139138
* The search is case insensitive. e.g `ham` will match `Ham`
@@ -179,7 +178,7 @@ Deletes the 1st item in the results of the `search` command.
179178
=== Tagging an item : `tag`
180179
181180
Tags an item from the list according to user input or clears item of tags. +
182-
Format: `tag|<index>|#tag...`
181+
Format: `tag|<index>|[<tag>]...`
183182
184183
****
185184
* Tags the item at the specified `<index>`.
@@ -226,21 +225,21 @@ There is no need to save manually.
226225
227226
== Command Summary
228227
229-
* *Add* `add|<item name>|<expiry date>` +
228+
* *Add* `add|<item name>|<expiry date>|[<tag>]...` +
230229
e.g. `add|durian|30/9/2019`
231230
* *Clear* : `clear`
232231
* *Delete* : `delete|<index>` +
233232
e.g. `delete|3`
234233
* *List* : `list`
235-
* *Sort* : `sort|<method>`+
234+
* *Sort* : `sort|<key>`+
236235
e.g. `sort|date`
237236
//* *Edit* : `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]...` +
238237
//e.g. `edit 2 n/James Lee e/jameslee@example.com`
239-
* *Search* : `search|<keyword>|[other keywords...]` +
238+
* *Search* : `search|<keyword>[|<other keywords>]...` +
240239
e.g. `search|milk|tea|pearls`
241-
* *Tag* : `tag|<index>|#tag...`
240+
* *Tag* : `tag|<index>|[<tag>]...`
242241
* *View* : `view`
243-
* *Check* : `check|<days>` +
242+
* *Check* : `check[|<days>]` +
244243
e.g. `check|20`
245244
* *Help* : `help`
246245

0 commit comments

Comments
 (0)