Merge pull request #98 from NgYaoDong/NgYaoDong-UserGuide

Update User Guide

docs/DeveloperGuide.md

@@ -1,6 +1,43 @@
 ---
 title: Developer Guide
 ---
+<!-- TOC -->
+  * [**Acknowledgements**](#acknowledgements)
+  * [**Design**](#design)
+    * [Architecture](#architecture)
+    * [UI component](#ui-component)
+    * [Parser component](#parser-component)
+    * [Commands component](#commands-component)
+    * [Data component](#data-component)
+    * [Storage component](#storage-component)
+    * [Common classes](#common-classes)
+    * [Exception classes](#exception-classes)
+  * [**Implementation**](#implementation)
+    * [Add product feature](#add-product-feature)
+      * [Class diagram of NewCommand:](#class-diagram-of-newcommand)
+    * [Edit product feature](#edit-product-feature)
+      * [Implementation](#implementation-1)
+    * [List feature](#list-feature)
+    * [InflowCommand Feature](#inflowcommand-feature)
+    * [OutflowCommand Feature](#outflowcommand-feature)
+    * [Delete product feature](#delete-product-feature)
+      * [Implementation](#implementation-2)
+    * [Find product feature](#find-product-feature)
+      * [Class diagram of FindCommand:](#class-diagram-of-findcommand)
+    * [History product feature](#history-product-feature)
+      * [Class diagram of HistoryCommand:](#class-diagram-of-historycommand)
+  * [**Appendix: Requirements**](#appendix-requirements)
+    * [Product scope](#product-scope)
+  * [User Stories](#user-stories)
+  * [Non-Functional Requirements](#non-functional-requirements)
+  * [Glossary](#glossary)
+  * [**Appendix: Instructions for manual testing**](#appendix-instructions-for-manual-testing)
+    * [Adding a Product](#adding-a-product)
+    * [Editing Product Details](#editing-product-details)
+    * [Deleting a product](#deleting-a-product)
+    * [Finding a keyword in the Product list](#finding-a-keyword-in-the-product-list-)
+    * [Finding all past transactions for a particular product in the Product list](#finding-all-past-transactions-for-a-particular-product-in-the-product-list)
+<!-- TOC -->
 
 ## **Acknowledgements**
 

docs/README.md

@@ -1,7 +1,20 @@
-# StockPal
 
-Useful links:
-* [User Guide](UserGuide.md)
-* [Developer Guide](DeveloperGuide.md)
-* [About Us](AboutUs.md)
+[![Java CI](https://github.com/AY2324S2-CS2113T-T09-3/tp/actions/workflows/gradle.yml/badge.svg?branch=master)](https://github.com/AY2324S2-CS2113T-T09-3/tp/actions/workflows/gradle.yml)
 
+![Ui](images/Ui.png)
+
+**StockPal is a CLI application designed for small business owners.**<br>
+Provides a user-friendly and cost-effective solution for small business owners to manage their inventory, eliminating the hassle of manual tracking of items.
+
+
+* If you are interested in using StockPal, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.md#quick-start).
+* If you are interested about developing StockPal, the [**Developer Guide**](DeveloperGuide.md) is a good place to start.
+
+
+Project Repository:<br>
+[![Project Repository](images/github-icon.png)](https://github.com/AY2324S2-CS2113T-T09-3/tp)
+
+
+**Acknowledgements**
+
+* Libraries used: [OpenCSV](https://opencsv.sourceforge.net/), [JSON-Java](https://github.com/stleary/JSON-java)