aboutsummaryrefslogtreecommitdiffstats
path: root/app
diff options
context:
space:
mode:
authorLazaridis <info@lazaridis.com>2018-03-10 10:56:39 +0800
committerLazaridis <info@lazaridis.com>2018-03-14 21:33:22 +0800
commit2d3763d70927dd1aefbc19f9ab6d463a713f2576 (patch)
treec42e7449b43b61d56e7ce8b379c9c9c6e29b696d /app
parentddc85354d3df508cbecc016fc0213a6560d885e1 (diff)
downloadtangerine-wallet-browser-2d3763d70927dd1aefbc19f9ab6d463a713f2576.tar
tangerine-wallet-browser-2d3763d70927dd1aefbc19f9ab6d463a713f2576.tar.gz
tangerine-wallet-browser-2d3763d70927dd1aefbc19f9ab6d463a713f2576.tar.bz2
tangerine-wallet-browser-2d3763d70927dd1aefbc19f9ab6d463a713f2576.tar.lz
tangerine-wallet-browser-2d3763d70927dd1aefbc19f9ab6d463a713f2576.tar.xz
tangerine-wallet-browser-2d3763d70927dd1aefbc19f9ab6d463a713f2576.tar.zst
tangerine-wallet-browser-2d3763d70927dd1aefbc19f9ab6d463a713f2576.zip
add READMEs to folders, re #3427
Diffstat (limited to 'app')
-rw-r--r--app/scripts/README.md14
-rw-r--r--app/scripts/controllers/README.md4
-rw-r--r--app/scripts/migrations/README.md5
3 files changed, 23 insertions, 0 deletions
diff --git a/app/scripts/README.md b/app/scripts/README.md
new file mode 100644
index 000000000..f5a907244
--- /dev/null
+++ b/app/scripts/README.md
@@ -0,0 +1,14 @@
+# Main MetaMask Code
+
+This folder contains the core-code.
+
+Currently, it is organized mostly based on file category, like:
+
+controllers, migrations, lib
+
+## Ongoing Task
+
+Refactor code-structure, thus the subsystems are reflected on the filesystem.
+
+### Examples
+
diff --git a/app/scripts/controllers/README.md b/app/scripts/controllers/README.md
new file mode 100644
index 000000000..392c0457d
--- /dev/null
+++ b/app/scripts/controllers/README.md
@@ -0,0 +1,4 @@
+# Controllers
+
+Different controllers (in the sense of *VC *View-Controller).
+
diff --git a/app/scripts/migrations/README.md b/app/scripts/migrations/README.md
new file mode 100644
index 000000000..3a67b08e1
--- /dev/null
+++ b/app/scripts/migrations/README.md
@@ -0,0 +1,5 @@
+# Migrations
+
+Data (user data, config files etc.) is migrated from one version to another.
+
+Migrations are called by {} from {} during {}. \ No newline at end of file