aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDan Finlay <542863+danfinlay@users.noreply.github.com>2019-02-26 03:10:13 +0800
committerWhymarrh Whitby <whymarrh.whitby@gmail.com>2019-02-26 03:10:13 +0800
commitf507f2a92710285679123c9429a37c9e330c7cac (patch)
tree30225a55e9d8fc273304f4e2548413a08f008aef /docs
parentfdc7eb211340b3af035a7f7c023155a8f1b1675d (diff)
downloadtangerine-wallet-browser-f507f2a92710285679123c9429a37c9e330c7cac.tar
tangerine-wallet-browser-f507f2a92710285679123c9429a37c9e330c7cac.tar.gz
tangerine-wallet-browser-f507f2a92710285679123c9429a37c9e330c7cac.tar.bz2
tangerine-wallet-browser-f507f2a92710285679123c9429a37c9e330c7cac.tar.lz
tangerine-wallet-browser-f507f2a92710285679123c9429a37c9e330c7cac.tar.xz
tangerine-wallet-browser-f507f2a92710285679123c9429a37c9e330c7cac.tar.zst
tangerine-wallet-browser-f507f2a92710285679123c9429a37c9e330c7cac.zip
Feature Flag + Mobile Sync (#5955)
Diffstat (limited to 'docs')
-rw-r--r--docs/README.md1
-rw-r--r--docs/secret-preferences.md10
2 files changed, 11 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
index c6e7dae6c..3c9bc0b4a 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -18,3 +18,4 @@ To learn how to develop MetaMask-compatible applications, visit our [Developer D
- [How to manage notices that appear when the app starts up](./notices.md)
- [How to port MetaMask to a new platform](./porting_to_new_environment.md)
- [How to generate a visualization of this repository's development](./development-visualization.md)
+- [How to add a feature behind a secret feature flag](./secret-preferences.md)
diff --git a/docs/secret-preferences.md b/docs/secret-preferences.md
new file mode 100644
index 000000000..f9d01a503
--- /dev/null
+++ b/docs/secret-preferences.md
@@ -0,0 +1,10 @@
+# Secret Preferences
+
+Sometimes we want to test a feature in the wild that may not be ready for public consumption.
+
+One example is our "sync with mobile" feature, which didn't make sense to roll out before the mobile version was live.
+
+To enable features like this, first open the background console, and then you can use the global method `global.setPreference(key, value)`.
+
+For example, if the feature flag was a booelan was called `mobileSync`, you might type `setPreference('mobileSync', true)`.
+