diff options
author | Peter 'Pita' Martischka <petermartischka@googlemail.com> | 2011-07-27 20:18:55 +0100 |
---|---|---|
committer | Peter 'Pita' Martischka <petermartischka@googlemail.com> | 2011-07-27 20:18:55 +0100 |
commit | fbcfd44fe2ea0eb83652d9c03b4b9bc74ebd85f1 (patch) | |
tree | c8e38ae23ac861272f7e29f0dbf0904a13f90715 | |
parent | fd329c189ae2a1f515974bf725475222e933e128 (diff) | |
download | etherpad-lite-fbcfd44fe2ea0eb83652d9c03b4b9bc74ebd85f1.zip |
Added a README that explains the folder structure
-rw-r--r-- | node/README.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/node/README.md b/node/README.md new file mode 100644 index 00000000..031810f6 --- /dev/null +++ b/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 |