Include installations instructions in README

This commit is contained in:
Aakash N S 2015-11-02 02:32:01 +05:30
parent 68d215567f
commit f238dd3734
1 changed files with 50 additions and 0 deletions

View File

@ -1,2 +1,52 @@
# react-native-dialogs
React Native wrappers for https://github.com/afollestad/material-dialogs
Installation
------------
Install the npm package 'react-native-dialogs'. Inside your React Native project, run :
```bash
npm install --save react-native-dialogs
```
Changes to your `package.json` should look like [this](https://github.com/aakashns/react-native-dialogs-example/commit/e6b83bf3d2238cf7e4ec3688519f38b2544ccad5).
In `android/settings.gradle`, remove the line `include ':app'` and add the following lines :
```
include ':app', ':react-native-dialogs'
project(':react-native-dialogs').projectDir = file('../node_modules/react-native-dialogs/android')
```
The changes should look like [this](https://github.com/aakashns/react-native-dialogs-example/commit/32b4159725601e0ea17e140f0a9b62161d567804)
**NOTE** : If you have included other libraries in your project, the `include` line will contain the other dependencies too, apart from `':app'` and `':react-native-dialogs'`
In `android/app/build.gradle`, add a dependency to `':react-native-dialogs'` and URL of the Jitpack maven repository (to download the library https://github.com/afollestad/material-dialogs) :
```
repositories {
maven { url "https://jitpack.io" }
}
dependencies {
// after other dependencies
compile project(':react-native-dialogs')
}
```
The changes should look like [this](https://github.com/aakashns/react-native-dialogs-example/commit/b58086d8fb9ece99f0e678dd8bf0e689a856bd43)
Next, you need to change the `MainActivity` of your app to extends `FragmentActivity` instead of `Activity` (otherwise dialogs will not be rendered), and register `ReactNativeDialogsPackage` :
```java
import android.support.v4.app.FragmentActivity;
import com.aakashns.reactnativedialogs.ReactNativeDialogsPackage;
public class MainActivity extends FragmentActivity implements DefaultHardwareBackBtnHandler {
//...
mReactInstanceManager = ReactInstanceManager.builder()
//...
.addPackage(new MainReactPackage())
.addPackage(new ReactNativeDialogsPackage(this)) // <- ADD THIS LINE!
//...
.build();
```
See [this changelog](https://github.com/aakashns/react-native-dialogs-example/commit/52cac27756963bcd2f4fdcd039e1a78028bb0abd) for reference
Now you're finally ready to start using module in your React Native application. See [this changelog](https://github.com/aakashns/react-native-dialogs-example/commit/2d8e02c22275479d2fbbb89f99dcb846834bec9d) for an example that uses `DialogAndroid`.