From e6ab06e1ac5200eec94165dd0bddb667c8120d63 Mon Sep 17 00:00:00 2001
From: Resul Avan <Resul.Avan@rabobank.nl>
Date: Tue, 21 Jul 2020 03:17:37 +0200
Subject: [PATCH] readme update for modules

---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/README.md b/README.md
index 4d7fd8b..822e2b5 100644
--- a/README.md
+++ b/README.md
@@ -21,8 +21,36 @@ See the [Features](#features) for more functionalities
 
 - [functions](./functions): source folder for firebase-functions
     - [modules](./functions/modules): Shared types and functions between front-end and back-end (firebase-functions and nuxt serverMiddleware)
+        - [types-module](./functions/modules/types-module): has all shared types (enums, interfaces, constants)
+        - [handlers-module](./functions/modules/handlers-module): has all express handlers. Also, has all backend services like firebase-admin and firestore
+    - src: the source of the functions
 - [src](./src): nuxt application
 
+```shell script
+|-- functions
+|   |-- modules
+|   |   |-- handlers-module
+|   |   |   `-- src
+|   |   `-- types-module
+|   |       `-- src
+|   `-- src
+`-- src
+    |-- assets
+    |-- components
+    |-- i18n
+    |-- layouts
+    |-- middleware
+    |-- mixin
+    |-- pages
+    |-- plugins
+    |-- server
+    |-- service
+    |-- static
+    |-- store
+    |-- types
+
+```
+
 
 ## DETAILED DOCUMENTATION
 > Coming soon
@@ -31,6 +59,7 @@ See the [Features](#features) for more functionalities
 - [x] nuxtjs - universal mode
     - [x] dynamic profile page with username
 - [x] typescript
+- [x] local npm modules for shared types and functions
 - [x] firebase
     - [x] firebase-hosting
     - [x] firebase-functions