Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
Also uploaded PDF versions of reports
  • Loading branch information
eleow committed Mar 31, 2020
1 parent 64336a9 commit c89c37e
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ This was the group project by <a href="https://github.com/eleow">Edmund</a>, <a

The objective of the chatbot is to give users better "decision simplicity" in their shopping for headphones, utilising Google DialogFlow, rasa NLU, Kommunicate, and other NLP techniques and libraries. As a demo, the deployed chatbot would be embedded within a (fake) headphones website.


![ShopBot](/_misc/store.png?raw=true&s=200)


## Getting Started
Expand All @@ -46,12 +46,11 @@ The objective of the chatbot is to give users better "decision simplicity" in th
git clone https://github.com/eleow/shopBot.git
```

* Refer to [User Guide](https://github.com/eleow/shopBot/blob/master/docs/User%20Guide.docx)
* Refer to [User Guide](https://github.com/eleow/shopBot/blob/master/docs/User%20Guide.pdf)

## Usage

![ShopBot](/_misc/persona.png?raw=true&s=100)

Refer to [Product Guide](https://github.com/eleow/shopBot/blob/master/docs/Product%20Guide.pdf) for full details.

The following intents are available

Expand All @@ -61,7 +60,7 @@ The following intents are available

### Get product recommendations

TODO
Based on user’s preferences, including whether he would like earphones or headphones, the connectivity type and desired brands, results are returned to the user. The sentiments for the aspects design, fit, price and sound are displayed, along with product name and price. The review rating from Amazon consumers is also provided.

### Get answers to FAQ on headphone-related stuff

Expand Down
Binary file added _misc/store.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Project Report.pdf
Binary file not shown.
Binary file added docs/User Guide.pdf
Binary file not shown.

0 comments on commit c89c37e

Please sign in to comment.