Merge pull request #448 from BranchMetrics/cleanup

v3

Author: ethanneff

.gitignore

@@ -1,19 +1,9 @@
+/tmp/
+node_modules/
+
 .DS_Store
-testbed/platforms
-testbed/plugins
-testbed/hooks
-testbed/build.json
-testbed/config.xml
-testbed/package.json
-node_modules
 .installed
-.gradle/
-.idea/
-tmp/
-cordova-ionic-phonegap-branch-deep-linking.iml
-local.properties
-out/
-npm-debug.log*
-*.map
+
 package-lock.json
-yarn-error.log
+npm-debug.log*
+yarn-error.log*

.npmignore

@@ -1,9 +1,14 @@
-node_modules
+/examples/
+/tmp/
+node_modules/
+
+.DS_Store
 .installed
-tests/
-testbed/
+
+npm-debug.log*
+yarn-error.log*
+
+package-lock.json
 plugin.template.xml
 gulpfile.js
-CONTRIBUTING.md
-travis_after_all.py
-yarn.lock
+CONTRIBUTING.md

.travis.yml

@@ -1,23 +1,21 @@
 sudo: false
 language: node_js
+node_js:
+  - 9
+  - 8
+  - 7
 cache:
+  yarn: true
   directories:
     - node_modules
 notifications:
   email: false
-node_js:
-  - '6'
-before_install:
-  - npm i -g npm@^2.0.0
-before_script:
-  - curl -Lo travis_after_all.py https://git.io/vLSON
-  - npm prune
+install:
+  - npm install
 script:
   - npm run validate
-  - npm run changelog
 after_success:
-  - python travis_after_all.py
-  - npm run semantic-release
+  - npm run travis-deploy-once "npm run semantic-release"
 branches:
   only:
     - master

CONTRIBUTING.md

@@ -1,27 +1,27 @@
 # Contributing
 
-*Questions? [Contact us](https://support.branch.io/support/tickets/new)*
+_Questions? [Contact us](https://support.branch.io/support/tickets/new)_
 
-1. [Todo](#todo)
-1. [Data Flow](#data-flow)
-1. [Dependencies](#dependencies)
-1. [Setup](#setup)
-1. [Develop](#develop)
-1. [Test](#test)
-1. [Submit](#submit)
-1. [Publish](#publish)
+1.  [Todo](#todo)
+1.  [Data Flow](#data-flow)
+1.  [Dependencies](#dependencies)
+1.  [Setup](#setup)
+1.  [Develop](#develop)
+1.  [Test](#test)
+1.  [Submit](#submit)
+1.  [Publish](#publish)
 
 ## Data Flow
 
-- [Users sets values](https://github.com/BranchMetrics/cordova-ionic-phonegap-branch-deep-linking/blob/master/testbed/config.template.xml#L6-L13)
-- [Hooks run on build](https://github.com/BranchMetrics/cordova-ionic-phonegap-branch-deep-linking/blob/master/plugin.xml#L45-L47)
-- [Hooks call scripts](https://github.com/BranchMetrics/cordova-ionic-phonegap-branch-deep-linking/tree/master/src/scripts/hooks)
-- [Scripts for iOS](https://github.com/BranchMetrics/cordova-ionic-phonegap-branch-deep-linking/tree/master/src/scripts/ios)
-- [Scripts for Android](https://github.com/BranchMetrics/cordova-ionic-phonegap-branch-deep-linking/tree/master/src/scripts/android)
+* [Users sets values](https://github.com/BranchMetrics/cordova-ionic-phonegap-branch-deep-linking/blob/master/testbed/config.template.xml#L6-L13)
+* [Hooks run on build](https://github.com/BranchMetrics/cordova-ionic-phonegap-branch-deep-linking/blob/master/plugin.xml#L45-L47)
+* [Hooks call scripts](https://github.com/BranchMetrics/cordova-ionic-phonegap-branch-deep-linking/tree/master/src/scripts/hooks)
+* [Scripts for iOS](https://github.com/BranchMetrics/cordova-ionic-phonegap-branch-deep-linking/tree/master/src/scripts/ios)
+* [Scripts for Android](https://github.com/BranchMetrics/cordova-ionic-phonegap-branch-deep-linking/tree/master/src/scripts/android)
 
 ## Dependencies
 
-- Homebrew
+* Homebrew
 
   ```sh
   ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)";
@@ -30,27 +30,21 @@
   export PATH="/usr/local/bin:$PATH";
   ```
 
-- Node
+* Node
 
   ```sh
   brew install node;
   ```
 
-- Gulp
-
-  ```sh
-  npm install -g gulp-cli; # linter
-  ```
-
-- Yarn
+* Yarn
 
   ```sh
   npm install -g yarn # faster npm
   ```
 
 ## Setup
 
-- Local
+* Local
 
   ```sh
   git clone [email protected]:BranchMetrics/cordova-ionic-phonegap-branch-deep-linking.git;
@@ -60,60 +54,52 @@
 
 ## Develop
 
-- Changes to `/src` don't need a `init.sh` rebuild, just a `cordova run ios`
+* Changes to `/src` don't need a `yarn examples` rebuild, just a `cordova run`
+* Changes to `/src/index.js` need changes to `testbed/platforms/ios/platform_www/plugins/branch-cordova-sdk` and a `cordova run ios`
 
-- **[optional]** Update [Android](https://github.com/BranchMetrics/android-branch-deep-linking/releases) and [iOS](https://github.com/BranchMetrics/ios-branch-deep-linking/releases) SDKs
+* **[optional]** Update [Android](https://github.com/BranchMetrics/android-branch-deep-linking/releases) and [iOS](https://github.com/BranchMetrics/ios-branch-deep-linking/releases) SDKs
 
   ```sh
-  ./src/scripts/npm/updateNativeSdk.sh -a 2.5.9 
+  ./src/scripts/npm/updateNativeSdk.sh -a 2.5.9
   ./src/scripts/npm/updateNativeSdk.sh -i 0.13.5
   ```
 
-- **[optional]** Update `CHANGELOG.md`
-
-  ```sh
-  npm run changelog
-  ```
-
 ## Test
 
-- Validate all features on both `iOS` and `Android` on `device` only (no `simulator` or `TestFlight`)
+* Validate all features on both `iOS` and `Android` on `device` only (no `simulator` or `TestFlight`)
 
-  - ios
+  * build
 
     ```sh
-    ./testbed/init -idc
+    cd ./
+    yarn examples
     ```
-  
-  - android
 
     ```sh
-    ./testbed/init -adc
+    cd examples/cordova1
+    # (plug in devices)
+    # (ionic build if ionic 3)
+    cordova run ios
+    cordova run android
     ```
 
-  - files
-  
-    - test `branch.js` with console logs to Safari and Chrome inspectors
-    - test `hooks` by changing to `before_prepare` and console logs with `cordova build`
-    - test `BranchSDK.m` with `NSLog()` with Xcode
-    - test `BranchSDK.java` with `system.out.println()` with Android Studio
+  * files
+
+    * test `index.js` with console logs to Safari and Chrome inspectors
+    * test `hooks` by changing to `before_prepare` and console logs with `cordova build`
+    * test `BranchSDK.m` with `NSLog()` with Xcode
+    * test `BranchSDK.java` with `system.out.println()` with Android Studio
 
 ## Submit
 
-- **[required]** Git [comment prefix](https://github.com/semantic-release/semantic-release): `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `chore`, `revert`
+* **[required]** Git [comment prefix](https://github.com/semantic-release/semantic-release): `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `chore`, `revert`
 
-- Versioning and tags are handled automatically based on commit messages
+* Versioning and tags are handled automatically based on commit messages
 
-- Submit code with a [pull request](https://github.com/BranchMetrics/cordova-ionic-phonegap-branch-deep-linking)
+* Submit code with a [pull request](https://github.com/BranchMetrics/cordova-ionic-phonegap-branch-deep-linking)
 
 ## Publish
 
-- Pull request code review from a Branch team member
-
-- Merges will automatically add SDK to NPM
-
-## Additional
+* Pull request code review from a Branch team member
 
-  -  `<plugin name="branch-cordova-sdk" spec="../" />` or `cordova plugin add ../` causes an infinite loop when importing Branch on Cordova 7.0.1. Works on Cordova 6.5.0.
-  -  need to remove `TODO` from `init.sh` for `ios-sim` error
-  -  `cordova platform update [email protected]` added for Cordova 6.5.0 error on Android
+* Merges will automatically add SDK to NPM