diff --git a/README.md b/README.md index 69fc936..a1ff636 100644 --- a/README.md +++ b/README.md @@ -14,13 +14,17 @@ Screencast Install ======= - -1. `npm install react-native-simple-auth` -2. In XCode, in the project navigator right click `Libraries` ➜ `Add Files to [your project's name]` -3. Go to `node_modules` ➜ `react-native-simple-auth`➜ iOS and add `SimpleAuthWrapper.h` and `SimpleAuthWrapper.m` -4. Go to your project's root directory and add a Podfile similar to https://github.com/adamjmcgrath/react-native-simple-auth/blob/master/Podfile -5. Install CocoaPods https://guides.cocoapods.org/using/getting-started.html -6. Run `pod install` +1. Install react native and make sure it works. There are currently two supported approaches for installing React-Native, [npm](https://facebook.github.io/react-native/docs/getting-started.html#quick-start) or [CocoaPods](https://cocoapods.org/pods/React). Users have found the `npm` approach more stable for this library. +2. `npm install react-native-simple-auth` +3. In XCode, in the project navigator right click `Libraries` ➜ `Add Files to [your project's name]` +4. Go to `node_modules` ➜ `react-native-simple-auth`➜ iOS and add `SimpleAuthWrapper.h` and `SimpleAuthWrapper.m` +5. Go to your project's root directory and add a Podfile similar to [this example](https://github.com/adamjmcgrath/react-native-simple-auth/blob/master/Podfile). + * You may need to tell the podfile where to find your xcode project by adding the following to the podfile: + ```xcodeproj './path/to/your/.xcodeproj/project'``` +6. Install CocoaPods https://guides.cocoapods.org/using/getting-started.html +7. Run `pod install` + +If you encounter problems building the project after this, the [following install tips](https://github.com/adamjmcgrath/react-native-simple-auth/issues/14) may be of help. Usage =====