Skip to content

Commit bd30ca6

Browse files
committed
README updated
1 parent 15e2e66 commit bd30ca6

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[![Build Status](https://img.shields.io/github/workflow/status/tsmx/object-hmac/git-ci-build)](https://img.shields.io/github/workflow/status/tsmx/object-hmac/git-ci-build)
77
[![Coverage Status](https://coveralls.io/repos/github/tsmx/object-hmac/badge.svg?branch=master)](https://coveralls.io/github/tsmx/object-hmac?branch=master)
88

9-
> Create and verify HMAC's for JSON objects.
9+
> Create and verify HMAC for a JSON object.
1010
1111
Easily create and verify [HMAC's](https://en.wikipedia.org/wiki/HMAC) for your JSON objects to ensure data integrity and authenticity.
1212

@@ -18,28 +18,32 @@ Easily create and verify [HMAC's](https://en.wikipedia.org/wiki/HMAC) for your J
1818
const objectHmac = require('@tsmx/object-hmac');
1919
const key = 'HmacSecret-0815';
2020

21-
let obj = {
21+
let person = {
2222
name: 'Max',
2323
age: 32,
2424
hobbies: ['sports', 'travelling']
2525
};
2626

27-
objectHmac.createHmac(obj, key);
27+
objectHmac.createHmac(person, key);
2828

29-
// obj = {"name":"Max","age":32,"hobbies":["sports","travelling"],"__hmac":"37c2e448b6f4a72c9d8abc9a1ab6cada602c3785148caeeed5498ed065ddc69f"}
29+
// person = {"name":"Max","age":32,"hobbies":["sports","travelling"],"__hmac":"37c2e448b6f4a72c9d8abc9a1ab6cada602c3785148caeeed5498ed065ddc69f"}
3030
```
3131

3232
### Verify HMAC for a JSON object
3333

3434
```js
35-
// obj = {"name":"Max","age":32,"hobbies":["sports","travelling"],"__hmac":"37c2e448b6f4a72c9d8abc9a1ab6cada602c3785148caeeed5498ed065ddc69f"}
35+
// person = {"name":"Max","age":32,"hobbies":["sports","travelling"],"__hmac":"37c2e448b6f4a72c9d8abc9a1ab6cada602c3785148caeeed5498ed065ddc69f"}
3636

3737
const objectHmac = require('@tsmx/object-hmac');
3838
const key = 'HmacSecret-0815';
3939

40-
let verification = objectHmac.verifyHmac(obj, key);
41-
40+
let verification = objectHmac.verifyHmac(person, key);
4241
// true
42+
43+
person.age = 33;
44+
45+
let verificationAfterChange = objectHmac.verifyHmac(person, key);
46+
// false
4347
```
4448

4549
### Only calculate HMAC for a JSON object
@@ -49,14 +53,13 @@ const objectHmac = require('@tsmx/object-hmac');
4953
const key = 'HmacSecret-0815';
5054

5155

52-
let obj = {
56+
let person = {
5357
name: 'Max',
5458
age: 32,
5559
hobbies: ['sports', 'travelling']
5660
};
5761

58-
let hmac = objectHmac.calculateHmac(obj, key);
59-
62+
let hmac = objectHmac.calculateHmac(person, key);
6063
// 37c2e448b6f4a72c9d8abc9a1ab6cada602c3785148caeeed5498ed065ddc69f
6164
```
6265

0 commit comments

Comments
 (0)