mirror of
https://github.com/status-im/react-native-status-keycard.git
synced 2025-02-28 20:10:28 +00:00
53 lines
1.9 KiB
Markdown
53 lines
1.9 KiB
Markdown
|
|
# react-native-status-keycard
|
|
|
|
## Getting started
|
|
|
|
`$ npm install react-native-status-keycard --save`
|
|
|
|
### Mostly automatic installation
|
|
|
|
`$ react-native link react-native-status-keycard`
|
|
|
|
### Manual installation
|
|
|
|
|
|
#### iOS
|
|
|
|
1. In XCode, in the project navigator, right click `Libraries` ➜ `Add Files to [your project's name]`
|
|
2. Go to `node_modules` ➜ `react-native-status-keycard` and add `RNStatusKeycard.xcodeproj`
|
|
3. In XCode, in the project navigator, select your project. Add `libRNStatusKeycard.a` to your project's `Build Phases` ➜ `Link Binary With Libraries`
|
|
4. Run your project (`Cmd+R`)<
|
|
|
|
#### Android
|
|
|
|
1. Open up `android/app/src/main/java/[...]/MainActivity.java`
|
|
- Add `import com.reactlibrary.RNStatusKeycardPackage;` to the imports at the top of the file
|
|
- Add `new RNStatusKeycardPackage()` to the list returned by the `getPackages()` method
|
|
2. Append the following lines to `android/settings.gradle`:
|
|
```
|
|
include ':react-native-status-keycard'
|
|
project(':react-native-status-keycard').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-status-keycard/android')
|
|
```
|
|
3. Insert the following lines inside the dependencies block in `android/app/build.gradle`:
|
|
```
|
|
compile project(':react-native-status-keycard')
|
|
```
|
|
|
|
#### Windows
|
|
[Read it! :D](https://github.com/ReactWindows/react-native)
|
|
|
|
1. In Visual Studio add the `RNStatusKeycard.sln` in `node_modules/react-native-status-keycard/windows/RNStatusKeycard.sln` folder to their solution, reference from their app.
|
|
2. Open up your `MainPage.cs` app
|
|
- Add `using Status.Keycard.RNStatusKeycard;` to the usings at the top of the file
|
|
- Add `new RNStatusKeycardPackage()` to the `List<IReactPackage>` returned by the `Packages` method
|
|
|
|
|
|
## Usage
|
|
```javascript
|
|
import RNStatusKeycard from 'react-native-status-keycard';
|
|
|
|
// TODO: What to do with the module?
|
|
RNStatusKeycard;
|
|
```
|
|
|