summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorAndrej Mihajlov <and@codeispoetry.ru>2017-03-13 16:10:26 +0000
committerAndrej Mihajlov <and@codeispoetry.ru>2017-03-13 16:10:26 +0000
commit6e0ca3212a6c4e38ee5cf4089342cd9f711b0a7c (patch)
treea737d9c27f04de64e90544b5b0c375760daa7305
parent7c1df6a3b0d5f90a3b57e1682bcac0470fae3095 (diff)
downloadmullvadvpn-6e0ca3212a6c4e38ee5cf4089342cd9f711b0a7c.tar.xz
mullvadvpn-6e0ca3212a6c4e38ee5cf4089342cd9f711b0a7c.zip
Update README
-rw-r--r--README.md24
1 files changed, 23 insertions, 1 deletions
diff --git a/README.md b/README.md
index 4ac4769d6b..39f396de68 100644
--- a/README.md
+++ b/README.md
@@ -27,4 +27,26 @@
- **test/** - tests
- **scripts/** - support scripts for development
- **init.js** - entry file for electron, points to compiled **main.js**
-- **distribution.yml** - distribution configuration \ No newline at end of file
+- **distribution.yml** - distribution configuration
+
+## View layout
+
+Most of application layouts consist of header bar area and main content area. Three of components from `components/Layout` help to assemble each view, i.e:
+
+```
+<Layout>
+ <Header />
+ <Container>
+ { /* content goes here */ }
+ </Container>
+</Layout>
+```
+
+## Redux and Backend communication
+
+Redux store keeps data displayed in user interface. Backend is connected with the app via event system.
+
+There are two helpers responsible for events translation:
+
+- **app/lib/backend-redux-actions.js** - translates events into redux actions
+- **app/lib/backend-routing.js** - application logic based on received events (i.e managing active route etc..)