Update README.md (#407)

* Release 0.1.4 (#402) * URL Autocomplete (#378) * initial work for autocomplete * initial work for autocomplete * autocomplete working * Fix typo * More missing locales (#381) * add missing locales * snapshot * Support for develop branch (#377) * Fade in images + bugfixes (#385) * initial work for autocomplete * initial work for autocomplete * autocomplete working * fade in images everywhere * fade in images + fixes * fix snapshots * fix qr codes (#386) * Collectible transaction details (#390) * decode transfer data ERC721 * render tx element * tx details refactor * stable * more refactor * renderable gasprice * render hash * snapshots * fadein * Remove collectible if is being sent (#391) * delete collectible if collectible is being sent * remove collectible before clear tx * if * iOS Unsafe devices + other bugfixes (#389) * add remember me for unprotected devices * increase keychain security level * fix snapshots * fixes * dont pop submit view when going to etherscan * handle android back button * Upgrade react native to v0.58.4 (#393) * ios app working * rn navigation & co updated * fix snapshots * remove extra files * add mm faucet * fix detox android * Import from seed - "remember me" option (#394) * Added missing remember me in import from seed flow * Update snapshot * refactor complete (#395) * Portrait orientation by default (#397) * fix navbar when landscape * fix portrait * portrait android * revert * indentation * Lock deps by commit sha1 (#400) * lock deps by commit sha * fix merge conflicts * Show app version (#399) * refactor complete * show app version in settings => info * fix bad indentation * bump gaba (#401) * Update README.md (#327) * Update README.md * Updated instructions * Update README.md * fix indentation * remove tabs * Revert "Update README.md (#327)" (#406) This reverts commit 403e63c. * Revert "Revert "Update README.md (#327)" (#406)" This reverts commit ebd8a4f.
MetaMask · Feb 19, 2019 · c961dbe · c961dbe
1 parent f748bae
commit c961dbe
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -1,22 +1,62 @@
 ![MetaMask logo](logo.png?raw=true)
+# MetaMask 
+MetaMask is a mobile web browser that provides easy access to websites that use the [Ethereum](https://ethereum.org/) blockchain.
 
+For up to the minute news, follow our [Twitter](https://twitter.com/metamask_io) or [Medium](https://medium.com/metamask) pages.
 
-MetaMask is a mobile web browser that provides easy access to websites that use the [Ethereum](https://ethereum.org/) blockchain.
+To learn how to develop MetaMask-compatible applications, visit our [Developer Docs](https://metamask.github.io/metamask-docs/).
+
+## MetaMask Mobile 
+
+### Building locally 
+The code is built using React-Native and running code locally requires a Mac or Linux OS.
+
+- Install [Node.js](https://nodejs.org) **version 8 (latest stable) and npm@6**
+    - If you are using [nvm](https://github.com/creationix/nvm#installation) (recommended) running `nvm use` will automatically choose the right node version for you.
+    - If you install Node.js manually, ensure you're using npm@6
+        - Install npm@6 using `npm install -g npm@6`
+
+- Before starting, you need to install React Native dependencies:
+    - [MacOs](https://facebook.github.io/react-native/docs/getting-started.html#installing-dependencies-1) 
+    - [Linux](https://facebook.github.io/react-native/docs/getting-started.html#installing-dependencies-2)
+ -  Now clone this repo and then install all our dependencies
 
-[http://metamask.io/](http://metamask.io/)
+```bash
+cd MetaMask
+npm i
+```
+
+- Running the app on Android: 
 
-[![CircleCI](https://circleci.com/gh/MetaMask/MetaMask.svg?style=shield)](https://circleci.com/gh/MetaMask/MetaMask)
-[![codecov](https://codecov.io/gh/bitpshr/MetaMask/branch/master/graph/badge.svg)](https://codecov.io/gh/bitpshr/MetaMask)
+```bash
+npm run start:android
+```
 
-## Development
+- Running the app on iOS:
 
-The following instructions assume that the React Native [Getting Started](https://facebook.github.io/react-native/docs/getting-started.html) guide for your platform has been completed.
+```bash
+npm run start:ios
+```
 
+### Running tests:
+ - Unit test: 
+```
+npm run test:unit
+``` 
+ - E2E Tests (iOS)
 ```
-$ npm i
-$ react-native run-ios
+npm run test:e2e:ios
+``` 
+ - E2E Tests (Android)
 ```
+npm run test:e2e:android
+``` 
+
+
+### Troubleshooting 
 
+Visit [Troubleshooting for React Native](https://facebook.github.io/react-native/docs/troubleshooting#content)
+
 ## License
 
-[MIT](./LICENSE)
+TBD
diff --git a/ios/MetaMask.xcodeproj/project.pbxproj b/ios/MetaMask.xcodeproj/project.pbxproj
@@ -5,7 +5,6 @@
 	};
 	objectVersion = 46;
 	objects = {
-
 /* Begin PBXBuildFile section */
 		00C302E51ABCBA2D00DB3ED1 /* libRCTActionSheet.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 00C302AC1ABCB8CE00DB3ED1 /* libRCTActionSheet.a */; };
 		00C302E71ABCBA2D00DB3ED1 /* libRCTGeolocation.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 00C302BA1ABCB90400DB3ED1 /* libRCTGeolocation.a */; };
@@ -74,6 +73,7 @@
 		F5C5F10C32974C2D94FEA3F3 /* EvilIcons.ttf in Resources */ = {isa = PBXBuildFile; fileRef = BF485CDA047B4D52852B87F5 /* EvilIcons.ttf */; };
 		F719B7ED64E3484FB94EE77B /* Foundation.ttf in Resources */ = {isa = PBXBuildFile; fileRef = 42C6DDE3B80F47AFA9C9D4F5 /* Foundation.ttf */; };
 		FD9BDCD5059C483EAE9C0160 /* libRNVectorIcons.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 70BCC86172F14AB2BF4DDA97 /* libRNVectorIcons.a */; };
+		C017D5C2EDDF43E28281BE61 /* libRNDeviceInfo.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 3267A8153EF14962AB36C825 /* libRNDeviceInfo.a */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXContainerItemProxy section */
@@ -622,6 +622,8 @@
 		F562CA6B28AA4A67AA29B61C /* MaterialIcons.ttf */ = {isa = PBXFileReference; explicitFileType = undefined; fileEncoding = 9; includeInIndex = 0; lastKnownFileType = unknown; name = MaterialIcons.ttf; path = "../node_modules/react-native-vector-icons/Fonts/MaterialIcons.ttf"; sourceTree = "<group>"; };
 		F9DFF7AC557B46B6BEFAA1C1 /* libRNShakeEvent.a */ = {isa = PBXFileReference; explicitFileType = undefined; fileEncoding = 9; includeInIndex = 0; lastKnownFileType = archive.ar; path = libRNShakeEvent.a; sourceTree = "<group>"; };
 		FE3C9A2458A1416290DEDAD4 /* branch.json */ = {isa = PBXFileReference; explicitFileType = undefined; fileEncoding = 9; includeInIndex = 0; lastKnownFileType = unknown; name = branch.json; path = ../branch.json; sourceTree = "<group>"; };
+		860FD76FCE4B42508F477408 /* RNDeviceInfo.xcodeproj */ = {isa = PBXFileReference; name = "RNDeviceInfo.xcodeproj"; path = "../node_modules/react-native-device-info/ios/RNDeviceInfo.xcodeproj"; sourceTree = "<group>"; fileEncoding = undefined; lastKnownFileType = wrapper.pb-project; explicitFileType = undefined; includeInIndex = 0; };
+		3267A8153EF14962AB36C825 /* libRNDeviceInfo.a */ = {isa = PBXFileReference; name = "libRNDeviceInfo.a"; path = "libRNDeviceInfo.a"; sourceTree = "<group>"; fileEncoding = undefined; lastKnownFileType = archive.ar; explicitFileType = undefined; includeInIndex = 0; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */