aboutsummaryrefslogtreecommitdiffstats
path: root/docs/translating-guide.md
diff options
context:
space:
mode:
authorFrankie <frankie.diamond@gmail.com>2018-03-14 06:23:46 +0800
committerGitHub <noreply@github.com>2018-03-14 06:23:46 +0800
commitc83a9ceb04a485149fe65fbb2b44f0adeda696b1 (patch)
treec655ef0d88734a55ade8451ffe5e3032582f3ed3 /docs/translating-guide.md
parentd7bf6e36b1f40068eec1d6c3d30207f3fae5cfde (diff)
parent578139be4a048d1709de5c2b4b8db0a8c631d31c (diff)
downloadtangerine-wallet-browser-c83a9ceb04a485149fe65fbb2b44f0adeda696b1.tar
tangerine-wallet-browser-c83a9ceb04a485149fe65fbb2b44f0adeda696b1.tar.gz
tangerine-wallet-browser-c83a9ceb04a485149fe65fbb2b44f0adeda696b1.tar.bz2
tangerine-wallet-browser-c83a9ceb04a485149fe65fbb2b44f0adeda696b1.tar.lz
tangerine-wallet-browser-c83a9ceb04a485149fe65fbb2b44f0adeda696b1.tar.xz
tangerine-wallet-browser-c83a9ceb04a485149fe65fbb2b44f0adeda696b1.tar.zst
tangerine-wallet-browser-c83a9ceb04a485149fe65fbb2b44f0adeda696b1.zip
Merge branch 'master' into i#3509
Diffstat (limited to 'docs/translating-guide.md')
-rw-r--r--docs/translating-guide.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/translating-guide.md b/docs/translating-guide.md
new file mode 100644
index 000000000..62d444b5a
--- /dev/null
+++ b/docs/translating-guide.md
@@ -0,0 +1,18 @@
+# MetaMask Translation Guide
+
+The MetaMask browser extension supports new translations added in the form of new locales files added in `app/_locales`.
+
+- [The MDN Guide to Internationalizing Extensions](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Internationalization)
+
+## Adding a new Language
+
+Each supported language is represented by a folder in `app/_locales` whose name is that language's subtag ([look up a language subtag using this tool](https://r12a.github.io/app-subtags/)).
+
+Inside that folder there should be a `messages.json` file that follows the specified format. An easy way to start your translation is to first duplicate `app/_locales/en/messages.json` (the english translation), and then update the `message` key for each in-app message.
+
+That's it! When MetaMask is loaded on a computer with that language set as the system language, they will see your translation instead of the default one.
+
+## Testing
+
+To verify that your translation works, you will need to [build a local copy](https://github.com/MetaMask/metamask-extension#building-locally) of MetaMask.
+