updated README.md

README.md

@@ -1,2 +1,17 @@
 # ccapdev-mongoose
 Mongoose Tutorial for CCAPDEV1920T2
+
+This repository will help you integrate Mongoose to your web applications. This web application has two main features - a sign up feature and a profile feature. Upon signing-up, registered users may view their profile.
+
+## Contents:
+
+Each folder and file in this repository is properly documented. You may read the `README.md` file of each folder to understand its content. You may also read the inline comments of each file explaining the statements line-per-line.
+
+- [controllers](https://github.com/arvention/ccapdev-mongoose/tree/master/controllers) - This folder contains files which defines callback functions for client requests.
+- [models](https://github.com/arvention/ccapdev-mongoose/tree/master/models) - This folder contains files for database modeling and access.
+- [public](https://github.com/arvention/ccapdev-mongoose/tree/master/public) - This folder contains static assets such as css, js, and image files.
+- [routes](https://github.com/arvention/ccapdev-mongoose/tree/master/routes) - This folder contains files which describes the response of the server for each HTTP method request to a specific path in the server.
+- [views](https://github.com/arvention/ccapdev-mongoose/tree/master/views) - This folder contains all hbs files to be rendered when requested from the server.
+- [index.js](https://github.com/arvention/ccapdev-mongoose/blob/master/index.js) - The main entry point of the web application.
+
+## Follow the steps below to set-up and study this repository: