aboutsummaryrefslogtreecommitdiffstats
path: root/app
diff options
context:
space:
mode:
authorkumavis <kumavis@users.noreply.github.com>2018-03-21 07:28:47 +0800
committerGitHub <noreply@github.com>2018-03-21 07:28:47 +0800
commit1a60094d501d8b102127c2cfc7b2ff31070feeb1 (patch)
tree077d6b1b05baec9c288c74ff83e75f09373307b3 /app
parentef1b09a255acc54432c76d93494395539cb6ea1d (diff)
parent2d3763d70927dd1aefbc19f9ab6d463a713f2576 (diff)
downloadtangerine-wallet-browser-1a60094d501d8b102127c2cfc7b2ff31070feeb1.tar
tangerine-wallet-browser-1a60094d501d8b102127c2cfc7b2ff31070feeb1.tar.gz
tangerine-wallet-browser-1a60094d501d8b102127c2cfc7b2ff31070feeb1.tar.bz2
tangerine-wallet-browser-1a60094d501d8b102127c2cfc7b2ff31070feeb1.tar.lz
tangerine-wallet-browser-1a60094d501d8b102127c2cfc7b2ff31070feeb1.tar.xz
tangerine-wallet-browser-1a60094d501d8b102127c2cfc7b2ff31070feeb1.tar.zst
tangerine-wallet-browser-1a60094d501d8b102127c2cfc7b2ff31070feeb1.zip
Merge pull request #3504 from lazaridiscom/laz/i3427
adds 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