The Big Renaming - etherpad is now an NPM module

1 files changed, 13 insertions, 0 deletions

diff --git a/src/node/README.md b/src/node/README.md
new file mode 100644
index 00000000..031810f6
--- /dev/null
+++ b/src/node/README.md
@@ -0,0 +1,13 @@
+# About the folder structure
+
+* **db** - all modules that are accesing the data structure and are communicating directly to the database
+* **handler** - all modules that responds directly to requests/messages of the browser
+* **utils** - helper modules
+
+# Module name conventions
+
+Module file names starts with a capital letter and uses camelCase
+
+# Where does it start?
+
+server.js is started directly