Browse Source

Create README.md

Guy Carmeli 6 years ago
parent
commit
36c0046b3a
No account linked to committer's email address
1 changed files with 24 additions and 0 deletions
  1. 24
    0
      README.md

+ 24
- 0
README.md View File

1
+![npm](https://img.shields.io/npm/dw/react-native-navigation.svg)
2
+[![npm (tag)](https://img.shields.io/npm/v/react-native-navigation/latest.svg)](https://github.com/wix/react-native-navigation/tree/master)
3
+[![npm (tag)](https://img.shields.io/npm/v/react-native-navigation/snapshot.svg)](https://github.com/wix/react-native-navigation/tree/master)
4
+[![Build Status](https://img.shields.io/jenkins/s/http/jenkins-oss.wixpress.com:8080/job/multi-react-native-navigation-master.svg)](https://jenkins-oss.wixpress.com/job/multi-react-native-navigation-master/)
5
+[![Join us on Discord](https://img.shields.io/badge/discord-react--native--navigation-738bd7.svg?style=flat)](https://discord.gg/DhkZjq2)
6
+[![StackExchange](https://img.shields.io/stackexchange/stackoverflow/t/react-native-navigation.svg)](https://stackoverflow.com/questions/tagged/react-native-navigation)
7
+
8
+<h1 align="center">
9
+  <img src=".logo.png"/><br>
10
+  React Native Navigation
11
+</h1>
12
+
13
+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. Ready to get started? Check out the [docs](https://wix.github.io/react-native-navigation/).
14
+
15
+# Quick Links
16
+- [Documentation](https://wix.github.io/react-native-navigation/)
17
+- [Stack Overflow](http://stackoverflow.com/questions/tagged/react-native-navigation)
18
+- [Chat with us](https://discord.gg/DhkZjq2)
19
+- [Contributing](/docs/docs/WorkingLocally.md)
20
+
21
+# Installation
22
+As `react-native-navigation` is a native navigation library - integrating it into your app will require editing native files. Follow the installation guides in the [documentation](https://wix.github.io/react-native-navigation/v2/#/).
23
+
24
+