瀏覽代碼

Update README.md (#970)

Guy Carmeli 8 年之前
父節點
當前提交
d33a0c4e22
共有 1 個檔案被更改,包括 9 行新增23 行删除
  1. 9
    23
      README.md

+ 9
- 23
README.md 查看文件

@@ -15,6 +15,12 @@ App-wide support for 100% native navigation with an easy cross-platform interfac
15 15
 
16 16
 ----
17 17
 
18
+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.
19
+
20
+If you're trying to deliver a user experience that's on par with the best native apps out there, you simply can't compromise on JS-based components trying to fake the real thing.
21
+
22
+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).
23
+
18 24
 > ### Important
19 25
 > 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.
20 26
 
@@ -24,31 +30,11 @@ App-wide support for 100% native navigation with an easy cross-platform interfac
24 30
 
25 31
 >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.
26 32
 
27
-## Wiki
28
-
29
-* [Overview](https://github.com/wix/react-native-navigation/wiki)
30
-* [Why use this package](https://github.com/wix/react-native-navigation/wiki#why-use-this-package)
31
-* [Installation - iOS](https://github.com/wix/react-native-navigation/wiki/Installation---iOS#installation---ios)
32
-* [Installation - Android](https://github.com/wix/react-native-navigation/wiki/Installation---Android)
33
-* [Usage](https://github.com/wix/react-native-navigation/wiki/Usage)
34
-* [Top Level API](https://github.com/wix/react-native-navigation/wiki/Top-Level-API)
35
-* [Screen API](https://github.com/wix/react-native-navigation/wiki/Screen-API)
36
-* [Styling the navigator](https://github.com/wix/react-native-navigation/wiki/Styling-the-navigator)
37
-* [Adding buttons to the navigator](https://github.com/wix/react-native-navigation/wiki/Adding-buttons-to-the-navigator)
38
-* [Styling the tab bar](https://github.com/wix/react-native-navigation/wiki/Styling-the-tab-bar)
39
-* [Deep links](https://github.com/wix/react-native-navigation/wiki/Deep-links)
40
-* [Third party libraries support](https://github.com/wix/react-native-navigation/wiki/Third-party-libraries-support)
41
-* [Milestones](https://github.com/wix/react-native-navigation/wiki/Milestones)
42
-* [Contributing](https://github.com/wix/react-native-navigation/wiki/Contributing)
43
-* [License](https://github.com/wix/react-native-navigation/wiki#license)
44
-
45
-## Why use this package
33
+## Documentation
46 34
 
47
-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.
35
+The documentation website can be found [here]([Documentation](wix.github.io/react-native-navigation)).
48 36
 
49
-If you're trying to deliver a user experience that's on par with the best native apps out there, you simply can't compromise on JS-based components trying to fake the real thing.
50
-
51
-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).
37
+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)
52 38
 
53 39
 
54 40
 ## License