From b96b43458c84153539de4ac79972236fdc8f4f36 Mon Sep 17 00:00:00 2001 From: liuzehui03 Date: Thu, 4 Apr 2024 17:30:13 +0800 Subject: [PATCH] updated UG and list of commands in help --- docs/UserGuide.md | 36 ++++++++++++++++++++++++++- src/main/java/seedu/bookbuddy/Ui.java | 3 +++ 2 files changed, 38 insertions(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 87ca4c3a30..4da97e1dca 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -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 ```` @@ -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. @@ -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` diff --git a/src/main/java/seedu/bookbuddy/Ui.java b/src/main/java/seedu/bookbuddy/Ui.java index 5e6c38e549..d6418ba372 100644 --- a/src/main/java/seedu/bookbuddy/Ui.java +++ b/src/main/java/seedu/bookbuddy/Ui.java @@ -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"); }