Added some notes and improved demo on readme

Author: parmism

README.md

@@ -15,24 +15,24 @@ Each of us have created one or more PRs and most of these have been merged into
 - By Parmis
 - Implemented by UserSearchUI, which allows a user to type in a user's username to view their features (user and username so far).
 - User information is captured using ChangeController interface, which uses UserDatabse interfaces to retrieve the user of interest:
-![img.png](img.png)
+- ![img.png](img.png)
 - Here, Alex123 is not a user of the chat system:
-![img_1.png](img_1.png)
+- ![img_1.png](img_1.png)
 - parmis is a user of the chat system though:
-![img_2.png](img_2.png)
+- ![img_2.png](img_2.png)
 
 ### Profile feature modification
 - By Parmis
 - Implemented by UserMdoificationUI, which allows a user to verify their authority to access their account by confirming their username and password, and then choosing the feature they wish to modify, and enter the new value for it. 
 - User information is captured using UserPresenter interface, which uses UserAuthenticationI to confirm user's authority to make the change, then uses Changeable interface (use case) to make the changes to the User entity, and finally uses UserModificationGateway to relay the changed info to UserDatabase:
-![img_3.png](img_3.png)
+- ![img_3.png](img_3.png)
 - Here: Parmis's password is actually 123, so she doesn't get the chance to change her email:
-![img_4.png](img_4.png)
+- ![img_4.png](img_4.png)
 - as you can see, her email is unchanged.
 - now she enters the right password and tries again:
-![img_5.png](img_5.png)
+- ![img_5.png](img_5.png)
 - This time, change was successful. She could use this tool to similarly change her username or password too:
-![img_6.png](img_6.png)
+- ![img_6.png](img_6.png)
 
 
 ### App Screen UI

src/main/java/data_access/UserDatabase.java

@@ -41,6 +41,9 @@ public boolean UserExists(String username, String email) {
         return false;
     }
 
+    /**
+     * Checks if a user with given Username exists.
+     */
     @Override
     public boolean UserExists(String username) {
         for(User user: this.accountList){
@@ -71,6 +74,9 @@ public void createUser(String username, String password, String email, String ty
         }
     }
 
+    /**
+     * getUser retrieves a User object based on passed username.
+     */
     @Override
 //  To be edited to get user from the array format rather than the serialized format.
     public User getUser(String username) {
@@ -107,6 +113,9 @@ public List<User> getList() {
         }
     }
 
+    /**
+     * modifyUser updates the serialized database with modified user information.
+     */
     @Override
     public void modifyUser(String oldUsername, User modified){
 //        swap in modified user to accountList

src/main/java/entities/user_entities/User.java

@@ -5,7 +5,7 @@
 import interface_adapters.login_interface_adapters.Login;
 import use_cases.user_attribute_modification_use_case.Changeable;
 import interface_adapters.app_screen_interface_adapters.UserAppScreenGateway;
-import entities.chat;
+import entities.chat.*;
 
 import java.io.Serializable;
 import java.util.ArrayList;

src/main/java/interface_adapters/User_search_IA/UserRetriever.java

@@ -2,7 +2,7 @@
 
 import interface_adapters.user_registration_interface_adapters.UserExists;
 import entities.user_entities.User;
-
+// gives access to user entity.
 public interface UserRetriever extends UserExists {
     User getUser(String username);
 }

src/main/java/interface_adapters/profile_modification_IA/ChangeController.java

@@ -1,5 +1,8 @@
 package interface_adapters.profile_modification_IA;
 
+/**
+ * To make a change to User entity.
+ */
 public interface ChangeController {
     public boolean reportChange(String username, String password, String feature, String newFeature);
     }

src/main/java/interface_adapters/profile_modification_IA/UserAuthenticationI.java

@@ -1,7 +1,8 @@
 package interface_adapters.profile_modification_IA;
 
-// allows for ChangeController to authenticate user's username and password.
-
+/**
+ * allows for ChangeController to authenticate user's username and password.
+ */
 public interface UserAuthenticationI {
     public Boolean PasswordMatch(String attempt);
 }

src/main/java/screens/Profile_screen/UserSearchUI.java

@@ -38,7 +38,9 @@ public void actionPerformed(ActionEvent e) {
         frame.setVisible(true);
   }
 
-//  User_search_IA.UserPresenter makes UI implement showProfile to invert the use-case --> UI dependency
+    /**
+     * User_search_IA.UserPresenter makes UI implement showProfile to invert the use-case --> UI dependency
+     */
     @Override
     public String showProfile(String username) {
         //    setting up access to the database of users:

src/main/java/screens/profile_update_screen/UserModificationUI.java

@@ -74,8 +74,9 @@ public void actionPerformed(ActionEvent e) {
 
         frame.setVisible(true);
     }
-
-//      profile_modification_IA.ChangeController makes UI implement reportChange to invert the use-case --> UI dependency
+    /**
+     * profile_modification_IA.ChangeController makes UI implement reportChange to invert the use-case --> UI dependency
+     */
     @Override
     public boolean reportChange(String username, String password, String feature, String newFeature) {
         UserDatabase db = new UserDatabase();