Bladeren bron

update readme

Daniel Zlotin 7 jaren geleden
bovenliggende
commit
ead78d3641
2 gewijzigde bestanden met toevoegingen van 19 en 34 verwijderingen
  1. 19
    34
      README.md
  2. 0
    0
      UPDATING.md

+ 19
- 34
README.md Bestand weergeven

@@ -1,47 +1,33 @@
1
-# React Native Navigation
1
+
2
+<h1 align="center">
3
+  <img src="./logo.png"/><br>
4
+  React Native Navigation
5
+</h1>
2 6
 
3 7
 [![NPM Version](https://img.shields.io/npm/v/react-native-navigation.svg?style=flat)](https://www.npmjs.com/package/react-native-navigation)
4 8
 [![NPM Downloads](https://img.shields.io/npm/dm/react-native-navigation.svg?style=flat)](https://www.npmjs.com/package/react-native-navigation)
5 9
 [![Build Status](https://travis-ci.org/wix/react-native-navigation.svg?branch=master)](https://travis-ci.org/wix/react-native-navigation)
6 10
 [![Join us on Discord](https://img.shields.io/badge/discord-react--native--navigation-738bd7.svg?style=flat)](https://discord.gg/DhkZjq2)
7 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.
8 16
 
9
-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.
10
-
11
-<img src="https://github.com/wix/react-native/blob/master/assets/themes/bootstrap-3/images/demo.gif?raw=true" width="240">
12
-
13
-----
14
-
15
-> ### Important
16
-> 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.
17
+### tldr;
17 18
 
18
-> 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.37.0`**.
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/).
19 20
 
20
-> 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).
21
+<img src="https://github.com/wix/react-native/blob/master/src/videos/demo.gif?raw=true" width="240">&nbsp;&nbsp;&nbsp;&nbsp;
22
+<img src="https://github.com/wix/mobile/blob/master/src/videos/final_element_Transition.mp4.gif?raw=true" width="240">
21 23
 
22
->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.
24
+## Quick Links
25
+* [Documentation](https://wix.github.io/react-native-navigation/#/)
26
+* [Stack Overflow](http://stackoverflow.com/questions/tagged/react-native-navigation)
27
+* [Chat with us](https://discord.gg/DhkZjq2)
28
+* Bootstrap - If you prefer to learn more about the library and the APIs through code, head over to [the bootstrap example app](https://github.com/wix/react-native-navigation-bootstrap) or the more feature rich [JuneDomingo/movieapp](https://github.com/JuneDomingo/movieapp)
23 29
 
24
-## Wiki
25
-
26
-* [Overview](https://github.com/wix/react-native-navigation/wiki)
27
-* [Why use this package](https://github.com/wix/react-native-navigation/wiki#why-use-this-package)
28
-* [Installation - iOS](https://github.com/wix/react-native-navigation/wiki/Installation---iOS#installation---ios)
29
-* [Installation - Android](https://github.com/wix/react-native-navigation/wiki/Installation---Android)
30
-* [Usage](https://github.com/wix/react-native-navigation/wiki/Usage)
31
-* [Migrating to version 2.0](https://github.com/wix/react-native-navigation/wiki/Migrating-to-version-2.0)
32
-* [Top Level API](https://github.com/wix/react-native-navigation/wiki/Top-Level-API)
33
-* [Screen API](https://github.com/wix/react-native-navigation/wiki/Screen-API)
34
-* [Styling the navigator](https://github.com/wix/react-native-navigation/wiki/Styling-the-navigator)
35
-* [Adding buttons to the navigator](https://github.com/wix/react-native-navigation/wiki/Adding-buttons-to-the-navigator)
36
-* [Styling the tab bar](https://github.com/wix/react-native-navigation/wiki/Styling-the-tab-bar)
37
-* [Deep links](https://github.com/wix/react-native-navigation/wiki/Deep-links)
38
-* [Third party libraries support](https://github.com/wix/react-native-navigation/wiki/Third-party-libraries-support)
39
-* [Release Notes](https://github.com/wix/react-native-navigation/blob/master/CHANGELOG.md)
40
-* [Milestones](https://github.com/wix/react-native-navigation/wiki/Milestones)
41
-* [Contributing](https://github.com/wix/react-native-navigation/wiki/Contributing)
42
-* [License](https://github.com/wix/react-native-navigation/wiki#license)
43
-
44
-## Why use this package
30
+----
45 31
 
46 32
 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.
47 33
 
@@ -55,4 +41,3 @@ For example, this package replaces the native [NavigatorIOS](https://facebook.gi
55 41
 The MIT License.
56 42
 
57 43
 See [LICENSE](LICENSE)
58
-

v1tov2diff.md → UPDATING.md Bestand weergeven