Skip to content

Commit 51fc3d6

Browse files
committed
README updated
1 parent b4583ab commit 51fc3d6

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
# React Native Sensitive Info
22

33
[![npm version](https://badge.fury.io/js/react-native-sensitive-info.svg)](https://badge.fury.io/js/react-native-sensitive-info)
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
45

5-
This module is the next generation of [react-native-get-shared-prefs](https://www.npmjs.com/package/react-native-get-shared-prefs).
6+
**react-native-sensitive-info** is the next generation of [react-native-get-shared-prefs](https://www.npmjs.com/package/react-native-get-shared-prefs).
67

78
# Introduction
89

910
`react-native-sensitive-info` manages all data stored in Android Shared Preferences and iOS Keychain. You can set and get all key/value using simple methods.
1011

12+
1113
| RN SensitiveInfo Version | Description |
1214
|--------------------------|----------------------------------|
1315
| 4.0+ | Compatible with RN 0.40+ |
@@ -74,7 +76,13 @@ protected List<ReactPackage> getPackages() {
7476

7577
Sync gradle and go :)
7678

77-
# Methods
79+
# Changelog
80+
81+
## Since version >= 5.0.0
82+
83+
We introduced **Android Keystore** securitY into our library. Also, we've fixed some issues and updated example.
84+
85+
Thanks to all contributors who helped us on our journey :)
7886

7987
## Since version >= 3.0.0
8088

@@ -110,7 +118,9 @@ import SInfo from 'react-native-sensitive-info';
110118

111119
SInfo.setItem('key1', 'value1', {
112120
sharedPreferencesName: 'mySharedPrefs',
113-
keychainService: 'myKeychain'});
121+
keychainService: 'myKeychain',
122+
encrypt: true
123+
});
114124

115125
SInfo.setItem('key2', 'value2');
116126

@@ -129,8 +139,8 @@ sharedPreferencesName: 'mySharedPrefs',
129139
keychainService: 'myKeychain'}).then(values => {
130140
console.log(values) //value1
131141
});
132-
133142
```
143+
134144
# Contributing
135145

136-
Pull requests are welcome :)
146+
Pull requests are always welcome :)

0 commit comments

Comments
 (0)