From 0a9598ae21fe7a4acf98687b976a5ee0dbc10425 Mon Sep 17 00:00:00 2001 From: lilia Date: Thu, 26 Mar 2015 10:46:40 -0700 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 32 +++++++++++++++++++++++++------- 1 file changed, 25 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9356ff5d..9c17a252 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,17 +1,25 @@ Contributor Guidelines -===================== +====================== -## Installation and setup +## Installation * Clone the repo * Open Chrome * Go to chrome://extensions/ * Enable developer mode (checkbox on the top right) * Click "Load unpacked extension..." -* Point to the repo's directory +* Point to the repo directory -Note that for development, you should always be using the staging server, which -uses a [self-signed ssl +## Developer Setup + +Note that for development, you should always be using the staging server +Registrations on the staging server are completely partitioned from the +productions server that the mobile apps use. A production app from the Play +store or iTunes is hard-coded to connect to the production server. If you wish +to pair your phone and computer, or test sending between the browser and +mobile, you must build a mobile client that targets the staging server. + +**Important!** The staging server uses a [self-signed ssl certificate](https://github.com/WhisperSystems/TextSecure-Browser/issues/110). By default, your browser will reject this certificate as insecure. Therefore, in order to register or send and receive messages of any kind, you must first @@ -20,14 +28,24 @@ click through the warnings to allow the certificate. If at any time you notice a console error about an "INSECURE RESPONSE" or "Handshake was canceled", repeat this step. -Once that's done, you can register for TextSecure using the instructions below: +## Pairing +Currently only the Android client supports multi-device pairing. + +0. Upon installing the extension you will be presented with a qr code. +1. Build a staging-flavored Android client and install it on your phone. +2. Scan the qr code with an barcode/qr scanning app and open the resulting url ("tsdevice://..."). +3. The phone will ask you to confirm adding the device. Click ok. +3. The browser will then ask you to confirm your phone number. Click ok and wait for setup to complete. Key generation can take up to a minute. + +## Standalone Registration **NOTE:** This is only for developers and will not be presented to users. -* Navigate to chrome-extension://.../register.html +* Open the registration page: chrome-extension://fpnlppjheenfplekcodjceiknbfnengc/register.html * Enter a real phone number (Google Voice numbers work too) and country combination and choose to send an SMS. You will receive a real SMS. * Enter the verification code you received by SMS. +* Wait for key generation to complete. You should now be able to use the extension. If you need to re-register, open a browser console within the extension options page (or inspect