update readme

README.md

@@ -5,10 +5,10 @@ This app aims to guide patients to choose suitable doctors in Amman according to
 ## Prerequisites
 Make sure you installed the following technologies locally:
 
-    React using webpack
-    Nodejs
-    Express
-    Mongodb
+    -React using webpack
+    - Nodejs
+    - Express
+    - Mongodb
 
 ## Getting started & Installation
 
@@ -31,33 +31,33 @@ Make sure you installed the following technologies locally:
 ## File Hieghrarcy  
     dazzel+
     ..../server
-    ........index.js
+    ........index.js (this includes server configuration and requests handling)
     ..../config
-    ........passport.js
+    ........passport.js (configuration for user authentication)
     ..../test
-    ........serverSpec.js
+    ........serverSpec.js (simple test)
     ..../views
-    ........admin.ejs
-    ........doctorform.ejs
-    ........login.ejs
-    ........signup.ejs
+    ........admin.ejs   (view form admin page)
+    ........doctorform.ejs (view form for doctor entry)
+    ........login.ejs  (form for login)
+    ........signup.ejs (form for signup)
     ..../database-mongo
-    ........index.js
+    ........index.js (database connection and schema defination)
     ..../react-client
-    ......../dist
-    ......../css
+    ......../dist (include static files)
+    ......../css 
     ............custom.css
     ........bundles.js
     ........index.html
     ......../src
-    ............index.jsx
+    ............index.jsx (the main react file -dome rendering)
     ......../components
-    ............Home.jsx
-    ............Map.jsx
-    ............Nearest.jsx
-    ............Rate.jsx
-    ............Specialities.jsx
-    ....package.json
+    ............Home.jsx (Home compoenent)
+    ............Map.jsx (a component to show the google map)
+    ............Nearest.jsx (a component to disply the closest doctors)
+    ............Rate.jsx (a compnent to display the list of doctors based on rate)
+    ............Specialities.jsx (a component to list doctor spcialization)
+    ....package.json (includes all dependencies)
     ....README.md
 
 
@@ -68,8 +68,7 @@ You can see a demo of the app in **Heroku**: https://app-dazzel.herokuapp.com/
 ## Contribution
 
 
-
-# Authors
+## Authors
 - Tal Omari - Product Owner.
 - Nada Ghanem - Scrum master.
 - Raed Awwad - Team member.