update docs (#958)

docs/README.md

@@ -4,14 +4,7 @@
   React Native Navigation
 </h1>
 
-[![NPM Version](https://img.shields.io/npm/v/react-native-navigation.svg?style=flat)](https://www.npmjs.com/package/react-native-navigation)
-[![NPM Downloads](https://img.shields.io/npm/dm/react-native-navigation.svg?style=flat)](https://www.npmjs.com/package/react-native-navigation)
-[![Build Status](https://travis-ci.org/wix/react-native-navigation.svg?branch=master)](https://travis-ci.org/wix/react-native-navigation)
-[![Join us on Discord](https://img.shields.io/badge/discord-react--native--navigation-738bd7.svg?style=flat)](https://discord.gg/DhkZjq2)
-
-App-wide support for 100% native navigation with an easy cross-platform interface. For iOS, this package is a wrapper around [react-native-controllers](https://github.com/wix/react-native-controllers), but provides a simplified more abstract API over it. This abstract API will be unified with the Android solution which is currently work in progress. It also fully supports redux if you use it.
-
-<img src="https://github.com/wix/react-native/blob/master/assets/themes/bootstrap-3/images/demo.gif?raw=true" width="240">
+App-wide support for 100% native navigation with an easy cross-platform interface.
 
 ----
 
@@ -22,8 +15,6 @@ App-wide support for 100% native navigation with an easy cross-platform interfac
 
 > The last stable version is `1.30.x` with npm tag `latest`. **This version supports react-native `0.25.1`**. It's installation instructions are [here](https://github.com/wix/react-native-navigation/blob/v1.x.x/README.md#installation---ios).
 
->If you don't want your code to break on a daily basis and don't need the new features ASAP please use the `latest` version or just specify a specific version number.
-
 ## Why use this package
 
 One of the major things missing from React Native core is fully featured native navigation. Navigation includes the entire skeleton of your app with critical components like nav bars, tab bars and side menu drawers.

docs/_sidebar.md

@@ -9,11 +9,9 @@
  - [Deep links](/deep-links)
  - [Android Scpecific Use Cases](/android-specific-use-cases)
  - [Third Party Libraries Support](/third-party-libraries-support)
- - [Contributing](/contributing)
 
 - Customization
   - [Styling the Navigator](/styling-the-navigator)
   - [Adding Buttons to the Navigator](/adding-buttons-to-the-navigator)
   - [Styling the Tab Bar](/styling-the-tab-bar)
-
-- [Milestones](milestones)
+  

docs/android-specific-use-cases.md

@@ -2,12 +2,12 @@
 
 TOC
 * [Activity Lifecycle and onActivityResult](https://github.com/wix/react-native-navigation/wiki/Android#activity-lifecycle-and-onactivityresult)
-* [Adjusting soft input mode](https://github.com/wix/react-native-navigation/wiki/Android/_edit#adjusting-soft-input-mode)
-* [Splash screen](https://github.com/wix/react-native-navigation/wiki/Android/_edit#splash-screen)
-* [Collapsing React header](https://github.com/wix/react-native-navigation/wiki/Android/_edit#collapsing-react-header---android-only)
-  * [Collapsing react view](https://github.com/wix/react-native-navigation/wiki/Android/_edit#collapsing-react-view)
+* [Adjusting soft input mode](https://github.com/wix/react-native-navigation/wiki/Android/#adjusting-soft-input-mode)
+* [Splash screen](https://github.com/wix/react-native-navigation/wiki/Android/#splash-screen)
+* [Collapsing React header](https://github.com/wix/react-native-navigation/wiki/Android/#collapsing-react-header---android-only)
+  * [Collapsing react view](https://github.com/wix/react-native-navigation/wiki/Android/#collapsing-react-view)
   * [Collapsing react view with top tabs](https://github.com/wix/react-native-navigation/wiki/Android/_edit#collapsing-react-view-with-top-tabs)
-* [Reloading from terminal](https://github.com/wix/react-native-navigation/wiki/Android/_edit#reloading-from-terminal)
+* [Reloading from terminal](https://github.com/wix/react-native-navigation/wiki/Android/#reloading-from-terminal)
 
 # Activity Lifecycle and onActivityResult
 In order to listen to activity lifecycle callbacks, set `ActivityCallback` in `MainApplication.onCreate` as follows:
@@ -90,7 +90,10 @@ static navigatorStyle = {
     navBarHideOnScroll: false,
     navBarBackgroundColor: '#4dbce9', // This will be the TitleBars color when the react view is hidden and collapsed
     collapsingToolBarComponent: 'example.header',
-    navBarTranslucent: true // Optional, sets a translucent dark background to the TitleBar. Useful when displaying bright colored header to emphasize the title and buttons in the TitleBar
+    navBarTranslucent: true, // Optional, sets a translucent dark background to the TitleBar. Useful when displaying bright colored header to emphasize the title and buttons in the TitleBar
+    showTitleWhenExpended: false, // default: true. Show the screens title only when the toolbar is collapsed
+    collapsingToolBarCollapsedColor: 'green', // optional. The TitleBar (navBar) color in collapsed state
+    collapsingToolBarExpendedColor: 'red' // optional. The TitleBar (navBar) color in expended state
   };
 }
 ```

docs/contributing.md

@@ -1,5 +0,0 @@
-# Contributing
-
-We are currently working hard on redesigning and refactoring this project with high quality and robustness in mind. As a result, issues and pull requests will take more time to process.
-
-If you have any question, you're welcome to join our [discord channel](https://discord.gg/DhkZjq2). Please try to use the issues section only for bug reports and suggestions for improvements.

docs/installation-android.md

@@ -1,15 +1,11 @@
 # Android Installation
 
 ### Important
-The `latest` (stable) version of this framework is `1.x.x` which supports react-native `0.25.1`. It's installation instructions are [here](https://github.com/wix/react-native-navigation/blob/v1.x.x/README.md#installation---android). To use it specify `"react-native-navigation": "latest"` in your package.json dependencies.
-
-The following instructions are for the `next` version `2.0.0-experimental.x`, which supports react-native `0.37.0`. To use it specify `"react-native-navigation": "next"` in your package.json dependencies. Bear in mind, as the name of the version suggests - this version is experimental and under heavy development, and will break from time to time - thus when using it you should check out these instructions from time to time to avoid breaking your project. 
+The following instructions are for the `next` version `2.0.0-experimental.x`, which supports react-native `0.40.0` or higher. To use it specify `"react-native-navigation": "next"` in your package.json dependencies. Bear in mind, as the name of the version suggests - this version is experimental and under heavy development.
 
 ----
 
-* Make sure you are using react-native version 0.37.0
-
- >Note: Android adaptation is still under active development therfore the API might break from time to time. 
+* Make sure you are using react-native version 0.40.0 or above
  
 1.  Add the following to your `settings.gradle` file located in the `android` folder:
 
@@ -19,14 +15,14 @@ The following instructions are for the `next` version `2.0.0-experimental.x`, wh
 	```
 	
 2. Update project dependencies in `build.gradle` under `app` folder.
-
 	```groovy
 	dependencies {
 	    compile fileTree(dir: "libs", include: ["*.jar"])
 	    compile "com.android.support:appcompat-v7:23.0.1"
 	    compile "com.facebook.react:react-native:+"
 	    compile project(':react-native-navigation')
-}
+	}
+	```
 
 3. Your `MainActivity` should extend `com.reactnativenavigation.controllers.SplashActivity` instead of `ReactActivity`. If you have any `react-native` related methods in your `MainActivity` you can safely delete them.
 
@@ -59,7 +55,6 @@ The following instructions are for the `next` version `2.0.0-experimental.x`, wh
 			return BuildConfig.DEBUG;
 		}
 
-	    @NonNull
 	    @Override
 	    public List<ReactPackage> createAdditionalReactPackages() {
 		    // Add the packages you require here.
@@ -68,4 +63,4 @@ The following instructions are for the `next` version `2.0.0-experimental.x`, wh
 	    }
 	}
 	```
-6. Run react-native start
+6. Run `react-native start`

docs/installation-ios.md

@@ -1,13 +1,11 @@
 # iOS Installation
 
 ### Important
-The `latest` (stable) version of this framework is `1.x.x` which supports react-native `0.25.1`. It's installation instructions are [here](https://github.com/wix/react-native-navigation/blob/v1.x.x/README.md#installation---ios). To use it specify `"react-native-navigation": "latest"` in your package.json dependencies.
-
-The following instructions are for the `next` version `2.0.0-experimental.x`, which supports react-native `0.37.0`. To use it specify `"react-native-navigation": "next"` in your package.json dependencies. Bear in mind, as the name of the version suggests - this version is experimental and under heavy development, and will break from time to time - thus when using it you should check out these instructions from time to time to avoid breaking your project. 
+The following instructions are for the `next` version `2.0.0-experimental.x`, which supports react-native `0.40.0` or higher. To use it specify `"react-native-navigation": "next"` in your package.json dependencies. Bear in mind, as the name of the version suggests - this version is experimental and under heavy development.
 
 ----
 
- * Make sure you are using react-native version 0.37.0
+ * Make sure you are using react-native version 0.40.0 or higher
 
  * In your project folder run `npm install react-native-navigation@next --save`
 > Note: We recommend using npm ver 3+. If you insist on using npm ver 2 please notice that the location for react-native-controllers in node_modules will be under the react-native-navigation folder and you'll need to change the paths in Xcode below accordingly.
@@ -20,4 +18,4 @@ The following instructions are for the `next` version `2.0.0-experimental.x`, wh
 
 * In Xcode, under your project files, modify `AppDelegate.m` according to this [example](https://github.com/wix/react-native-navigation/blob/master/example/ios/example/AppDelegate.m)
 
-* Run react-native start
+* Run `react-native start`

docs/milestones.md

@@ -1,24 +0,0 @@
-# Milestones
-
-### [Version 2.0.0](https://github.com/wix/react-native-navigation/milestone/1)
-
-> Due by November 30, 2016
-
-#### The general goals for this version are:
-* [react-native-controllers](https://github.com/wix/react-native-controllers) will be deprecated and fully merged into [react-native-navigation](https://github.com/wix/react-native-navigation).
-* iOS - Redesign and Refactor
-* Android - Redesign and Refactor
-* Complete feature parity between Android and iOS
-
-#### The main feature that we are planning for this version are:
-* [Screens lifecycle](https://github.com/wix/react-native-navigation/labels/Screens%20Lifecycle)
-* [Pass props and functions](https://github.com/wix/react-native-navigation/labels/Passprops%20%26%20Functions)
-* [Dynamic styling](https://github.com/wix/react-native-navigation/labels/Dynamic%20styling)
-
-
-### [Version 2.1.0](https://github.com/wix/react-native-navigation/milestone/2)
-
-#### The general goals for this version are:
-* Android tests
-* iOS tests
-* Activity results

docs/screen-api.md

@@ -11,7 +11,7 @@ this.props.navigator.push({
   screen: 'example.ScreenThree', // unique ID registered with Navigation.registerScreen
   title: undefined, // navigation bar title of the pushed screen (optional)
   titleImage: require('../../img/my_image.png'), //navigation bar title image instead of the title text of the pushed screen (optional)
-  passProps: {}, // simple serializable object that will pass as props to the pushed screen (optional)
+  passProps: {}, // Object that will be passed as props to the pushed screen (optional)
   animated: true, // does the push have transition animation or does it happen immediately (optional)
   backButtonTitle: undefined, // override the back button title (optional)
   backButtonHidden: false, // hide the back button altogether (optional)
@@ -226,7 +226,7 @@ export default class ExampleScreen extends Component {
   onNavigatorEvent(event) {
     switch(event.id) {
       case 'willAppear':
-	     break;
+       break;
       case 'didAppear':
         break;
       case 'willDisappear':

docs/styling-the-navigator.md

@@ -46,7 +46,10 @@ export default class StyledScreen extends Component {
   collapsingToolBarImage: require('../../img/topbar.jpg'), // Collapsing Toolbar image. Either use a url or require a local image. Android only
   collapsingToolBarCollapsedColor: '#0f2362', // Collapsing Toolbar scrim color. Android only
   navBarSubtitleColor: 'red', // subtitle color
-  screenBackgroundColor: 'white' // Default screen color, visible before the actual react view is rendered
+  screenBackgroundColor: 'white', // Default screen color, visible before the actual react view is rendered
+  orientation: 'portrait' // Sets a specific orientation to a modal and all screens pushed to it. Default: 'auto'. Supported values: 'auto', 'landscape', 'portrait'
+  disabledBackGesture: false, // disable the back gesture (swipe gesture) in order to pop the top screen. Default is false. iOS Only
+  screenBackgroundImageName: '<name of image in Images.xcassets>', // Optional. default screen background image. iOS only
 }
 ```
 

docs/top-level-api.md

@@ -47,6 +47,9 @@ Navigation.startTabBasedApp({
     tabBarSelectedButtonColor: '#ff9900', // optional, change the color of the selected tab icon and text (only selected)
     tabBarBackgroundColor: '#551A8B' // optional, change the background color of the tab bar
   },
+  appStyle: {
+    orientation: 'portrait' // Sets a specific orientation to the entire app. Default: 'auto'. Supported values: 'auto', 'landscape', 'portrait'
+  },
   drawer: { // optional, add this if you want a side menu drawer in your app
     left: { // optional, define if you want a drawer from the left
       screen: 'example.FirstSideMenu' // unique ID registered with Navigation.registerScreen

docs/usage.md

@@ -3,7 +3,7 @@
 If you don't like reading, just jump into the fully working example projects:
 
 * [example](https://github.com/wix/react-native-navigation/tree/master/example) - Example project showing the best practice use of this package. Shows many navigation features.
-* [redux-example(**deprecated**)](https://github.com/wix/react-native-navigation/tree/master/old-example-redux) - Best practice use of this package in a [redux](https://github.com/reactjs/redux)-based project.
+* [redux-example](https://github.com/wix/react-native-navigation/tree/master/old-example-redux) - (**deprecated** in favor of [JuneDomingo/movieapp](https://github.com/JuneDomingo/movieapp/tree/feature/similar-movies)) Best practice use of this package in a [redux](https://github.com/reactjs/redux)-based project.
 
 > Note: example redux is deprecated. Since we did not have enough time and resources to maintain both example projects, we decided to stop maintaining the redux example. This does not mean redux can't be used with react-native-navigation (In fact, we use redux in the Wix app). For a working example project which uses redux with RNN you can refer to [JuneDomingo/movieapp](https://github.com/JuneDomingo/movieapp).