Skip to content

Commit

Permalink
upated readme file and fixed plugin version and trying to fix untar i…
Browse files Browse the repository at this point in the history
…ssue on npm too
  • Loading branch information
pradeep1991singh committed Feb 17, 2017
1 parent 05c7476 commit 683ee47
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 10 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ cordova plugin add https://github.com/pradeep1991singh/cordova-plugin-secure-key

## Usage

- This plugin will add two new methods to window scope, one is for encrypting and other for decrypting keys.
This plugin will add three new methods to window scope, for saving sensitive data, retrieving saved data and for removing data.

- For saving string `cordova.plugins.SecureKeyStore.set` and for retrieving `cordova.plugins.SecureKeyStore.get`.
- For saving use `cordova.plugins.SecureKeyStore.set`

```js
cordova.plugins.SecureKeyStore.set(function (res) {
Expand All @@ -29,14 +29,16 @@ cordova.plugins.SecureKeyStore.set(function (res) {
}, "key", 'string to encrypt');
```

- For retrieving use `cordova.plugins.SecureKeyStore.get`.

```js
cordova.plugins.SecureKeyStore.get(function (res) {
console.log(res); // res - string retrieved
}, function (error) {
console.log(error);
}, "key");
```
- Apart from above there is one more method for removing saved key
- And for removing `cordova.plugins.SecureKeyStore.remove`

```js
cordova.plugins.SecureKeyStore.remove(function (res) {
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "cordova-plugin-secure-key-store",
"version": "1.4.3",
"version": "1.4.4",
"description": "Cordova plugin for securely saving keys, passwords or strings on devices.",
"cordova": {
"id": "cordova-plugin-secure-key-store",
Expand Down
9 changes: 3 additions & 6 deletions plugin.xml
Original file line number Diff line number Diff line change
@@ -1,22 +1,19 @@
<?xml version='1.0' encoding='utf-8'?>
<plugin id="cordova-plugin-secure-key-store"
version="1.4.2"
version="1.4.4"
xmlns="http://apache.org/cordova/ns/plugins/1.0"
xmlns:android="http://schemas.android.com/apk/res/android">

<name>SecureKeyStore</name>
<author>pradeep1991singh</author>
<author>pradeep singh</author>

<description>
Cordova plugin for securely saving keys, passwords or strings on devices.
</description>

<license>ISC</license>

<keywords>
ecosystem:cordova, ecosystem:phonegap, mobile, android, ios, android-keystore,
ios-keychain, sensitive-data-security, public-private-key, encryption-decryption
</keywords>
<keywords>ecosystem:cordova, ecosystem:phonegap, mobile, android, ios, android-keystore, ios-keychain, sensitive-data-security, public-private-key, encryption-decryption</keywords>

<js-module name="SecureKeyStore" src="www/SecureKeyStore.js">
<clobbers target="cordova.plugins.SecureKeyStore" />
Expand Down

0 comments on commit 683ee47

Please sign in to comment.