Skip to content

Commit

Permalink
Merge pull request nus-cs2113-AY2324S2#87 from liuzehui03/expanding_f…
Browse files Browse the repository at this point in the history
…ind_function

updated UG and list of commands in help
  • Loading branch information
liuzehui03 authored Apr 4, 2024
2 parents 710ffae + b96b434 commit 7b035be
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 1 deletion.
36 changes: 35 additions & 1 deletion docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,9 @@ rate [BOOK_INDEX] [BOOK_RATING] -> to rate a book from 1-5
list-rated -> to sort books by rating in descending order
display [BOOK_INDEX] -> to view more details about a book
find-title [KEYWORD] -> to find books with keyword in their title
find-genre -> to see all books with the selected genre
find-genre -> to find books under specific genres
find-read -> to find list of books that are read
find-unread -> to find list of books that are unread
bye -> to exit BookBuddy software
````

Expand Down Expand Up @@ -345,6 +347,36 @@ Enter the number for the desired genre:
1. [U] harry potter
````

### Find books that are read: `find-read`
Returns all books in the saved book list that are marked read.

Format: `find-read`

Example of usage with expected output:
````
//input
find-read
````
````
//ouput
1. [R] harry potter
````
### Find books that are unread: `find-unread`
Returns all books in the saved book list that are marked unread.

Format: `find-unread`

Example of usage with expected output:
````
//input
find-unread
````
````
//ouput
1. [U] geronimo stilton
2. [U] The Boy in Striped Pyjamas
````

### Exiting the program: `bye`

Exits the application and saves all tasks in a file.
Expand Down Expand Up @@ -390,4 +422,6 @@ to be saved.**
* Display details: `display [BOOK_INDEX]`
* Find books with specific title: `find-title [KEYWORD]`
* Find books with specific genre: `find-genre` followed by `[NUMBER]`
* Find books that are read: `find-read`
* Find books that are unread: `find-unread`
* Exit program: `bye`
3 changes: 3 additions & 0 deletions src/main/java/seedu/bookbuddy/Ui.java
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,9 @@ public static void helpMessage() {
System.out.println("list-rated -> to sort books by rating in descending order");
System.out.println("display [BOOK_INDEX] -> to view more details about a book");
System.out.println("find-title [KEYWORD] -> to find books with keyword in their title");
System.out.println("find-genre -> to find books under specific genres");
System.out.println("find-read -> to find list of books that are read");
System.out.println("find-unread -> to find list of books that are unread");
System.out.println("bye -> to exit BookBuddy software");
}

Expand Down

0 comments on commit 7b035be

Please sign in to comment.