status-im
/
react-native-keychain
mirror of https://github.com/status-im/react-native-keychain.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

update readme

This commit is contained in:
Vojtech Novak 2016-08-26 08:40:09 +02:00
parent 754b15075a
commit c93f9943d6
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -5,7 +5,7 @@ Currently functionality is limited to just storing internet and generic password
## Installation ## Installation
`$ npm install react-native-keychain` `$ npm install --save react-native-keychain`
### Option: Manually ### Option: Manually
@ -20,9 +20,9 @@ Add the following to your `Podfile` and run `pod update`:
pod 'RNKeychain', :path => 'node_modules/react-native-keychain' pod 'RNKeychain', :path => 'node_modules/react-native-keychain'
``` ```
### Option: With [rnpm](https://github.com/rnpm/rnpm) ### Option: With `react-native link`
`$ rnpm link` `$ react-native link`
## Usage ## Usage
@ -81,9 +81,17 @@ Keychain
### Android ### Android
### Option: With `react-native link`
`$ react-native link` and check MainApplication.java to verify the package was added.
* Note: Android support requires React Native 0.19 or later * Note: Android support requires React Native 0.19 or later
* on Android, the `setInternetCredentials(server, username, password)` call will be resolved as call to `setGenericPassword(username, password, server)` and the data will be saved in `SharedPreferences`, encrypted using Facebook conceal. Use the `server` argument to distinguish between multiple entries. * on Android, the `setInternetCredentials(server, username, password)` call will be resolved as call to `setGenericPassword(username, password, server)` and the data will be saved in `SharedPreferences`, encrypted using Facebook conceal. Use the `server` argument to distinguish between multiple entries.
### Option: Manually
* Edit `android/settings.gradle` to look like this (without the +): * Edit `android/settings.gradle` to look like this (without the +):
```diff ```diff