Преглед изворни кода

Update readme and docs after publishing v1.1.0 (#1092)

Daniel Zlotin пре 7 година
родитељ
комит
f314e57844
4 измењених фајлова са 13 додато и 19 уклоњено
  1. 5
    5
      README.md
  2. 4
    6
      docs/README.md
  3. 2
    4
      docs/installation-android.md
  4. 2
    4
      docs/installation-ios.md

+ 5
- 5
README.md Прегледај датотеку

@@ -9,6 +9,11 @@
9 9
 [![Build Status](https://travis-ci.org/wix/react-native-navigation.svg?branch=master)](https://travis-ci.org/wix/react-native-navigation)
10 10
 [![Join us on Discord](https://img.shields.io/badge/discord-react--native--navigation-738bd7.svg?style=flat)](https://discord.gg/DhkZjq2)
11 11
 
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
+
12 17
 ### tldr;
13 18
 
14 19
 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
23 28
 
24 29
 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).
25 30
 
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
-
31 31
 ## Documentation
32 32
 
33 33
 The documentation website can be found [here](http://wix.github.io/react-native-navigation).

+ 4
- 6
docs/README.md Прегледај датотеку

@@ -8,12 +8,10 @@ App-wide support for 100% native navigation with an easy cross-platform interfac
8 8
 
9 9
 ----
10 10
 
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.
17 15
 
18 16
 ## Why use this package
19 17
 

+ 2
- 4
docs/installation-android.md Прегледај датотеку

@@ -1,11 +1,9 @@
1 1
 # 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`
5 3
 
6 4
 ----
7 5
 
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
9 7
  
10 8
 1.  Add the following to your `settings.gradle` file located in the `android` folder:
11 9
 

+ 2
- 4
docs/installation-ios.md Прегледај датотеку

@@ -1,11 +1,9 @@
1 1
 # 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`
5 3
 
6 4
 ----
7 5
 
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
9 7
 
10 8
  * In your project folder run `npm install react-native-navigation@next --save`
11 9
 > 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.