Skip to content

Commit f314e57

Browse files
authored
Update readme and docs after publishing v1.1.0 (wix#1092)
1 parent f399cbe commit f314e57

4 files changed

Lines changed: 13 additions & 19 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@
99
[![Build Status](https://travis-ci.org/wix/react-native-navigation.svg?branch=master)](https://travis-ci.org/wix/react-native-navigation)
1010
[![Join us on Discord](https://img.shields.io/badge/discord-react--native--navigation-738bd7.svg?style=flat)](https://discord.gg/DhkZjq2)
1111

12+
## Important
13+
Latest stable version is `1.1.x` and is published to npm under tag `latest`. It supports react-native 0.43 and above.
14+
<br><br>We are currently redesigning and rewriting this project under branch `v2`.
15+
<br>As a result, new features and pull requests on the current stable version will take more time to process.
16+
1217
### tldr;
1318

1419
React Native Navigation provides 100% native platform navigation on both iOS and Android for React Native apps. The JavaScript API is simple and cross-platform - just install it in your app and give your users the native feel they deserve. Using redux? No problem: React Native Navigation comes with optional redux support out of the box. Ready to get started? Check out the [docs](https://wix.github.io/react-native-navigation/).
@@ -23,11 +28,6 @@ If you're trying to deliver a user experience that's on par with the best native
2328

2429
For example, this package replaces the native [NavigatorIOS](https://facebook.github.io/react-native/docs/navigatorios.html) that has been [abandoned](https://facebook.github.io/react-native/docs/navigator-comparison.html) in favor of JS-based solutions that are easier to maintain. For more details see in-depth discussion [here](https://github.com/wix/react-native-controllers#why-do-we-need-this-package).
2530

26-
> ### Important
27-
> 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.
28-
To avoid any confusion and breaking existing projects, all continuous development is published under the npm tag `next`, with version `2.0.0-experimental.x`. **This version supports react-native `0.40.0 and above`**. Once stable, we will publish it as `2.0.0`.
29-
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.
30-
3131
## Documentation
3232

3333
The documentation website can be found [here](http://wix.github.io/react-native-navigation).

docs/README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,10 @@ App-wide support for 100% native navigation with an easy cross-platform interfac
88

99
----
1010

11-
> ### Important
12-
> 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.
13-
14-
> To avoid any confusion and breaking existing projects, all continuous development is published under the npm tag `next`, with version `2.0.0-experimental.x`. Once stable, we will publish it as `2.0.0`. **This version supports react-native `0.40.0 and above`**.
15-
16-
> 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).
11+
## Important
12+
Latest stable version is `1.1.x` and is published to npm under tag `latest`. It supports react-native 0.43 and above.
13+
<br><br>We are currently redesigning and rewriting this project under branch `v2`.
14+
<br>As a result, new features and pull requests on the current stable version will take more time to process.
1715

1816
## Why use this package
1917

docs/installation-android.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
# Android Installation
2-
3-
### Important
4-
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.
2+
First add `react-native-navigation` as an npm dependency: `yarn add react-native-navigation`
53

64
----
75

8-
* Make sure you are using react-native version 0.40.0 or above
6+
* Make sure you are using react-native version 0.43 or above
97

108
1. Add the following to your `settings.gradle` file located in the `android` folder:
119

docs/installation-ios.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
# iOS Installation
2-
3-
### Important
4-
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.
2+
First add `react-native-navigation` as an npm dependency: `yarn add react-native-navigation`
53

64
----
75

8-
* Make sure you are using react-native version 0.40.0 or higher
6+
* Make sure you are using react-native version 0.43.0 or higher
97

108
* In your project folder run `npm install react-native-navigation@next --save`
119
> 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.

0 commit comments

Comments
 (0)