Skip to content

Commit

Permalink
Merge pull request nus-cs2113-AY2324S2#84 from yeozongyao/branch-zong…
Browse files Browse the repository at this point in the history
…yao-userGuide

Update User Guide to show target users and value proposition
  • Loading branch information
yeozongyao authored Apr 4, 2024
2 parents 4ba7692 + c46ceb0 commit 1a30ca0
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,18 @@ BookBuddy is an application that helps users track and manage the list of books
that they are reading. It is optimised for users that are familiar with the CLI so that
the tracking and management objectives can be achieved more efficiently.

#### Target user and value proposition
BookBuddy targets people who are comfortable and proficient with using command-line-interfaces(CLI). These users
typically prefers the efficiency and flexibility of CLI environments over Graphical user Interfaces (GUIs). They are
likely to be avid readers who read multiple books simultaneously and need an effective way to organise their reading
lists.

Therefore, BookBuddy offers a streamlined and efficient solution for tracking and managing reading lists directly from
the command line. It provides quick access to book management features for users who prefer keyboard-driven commands and
enjoy the directness and simplicity of CLI tools. With BookBuddy, users can easily add, update, and review their reading
progress without the overhead of navigating traditional graphical applications, saving time and enhancing their reading
experience.

## Table of Contents
* [Getting Started](#getting-started)
* [Features](#features)
Expand Down Expand Up @@ -256,6 +268,7 @@ list-rated
```

Example output:

````
Books sorted by rating:
The Boy in Striped Pyjamas - 5
Expand Down Expand Up @@ -283,7 +296,6 @@ Label: very cool
Genre: No genre provided
Rating: 3
Summary: A book about a young boy who is invited to study at Hogwarts.
````

### Finding a book by title: `find-title`
Expand Down

0 comments on commit 1a30ca0

Please sign in to comment.