Skip to content

Commit b6efe80

Browse files
committed
Update readme
1 parent 36070dd commit b6efe80

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
Deterministic `JSON.stringify()` - a faster version of [@epoberezkin](https://github.com/epoberezkin)'s [fast-json-stable-strigify](https://github.com/epoberezkin/fast-json-stable-stringify). Built with Typescript and modern Javascript.
66

7-
## Requirements
7+
## Compatibility
88

9-
NodeJS 10+ or broswer with ES2015 support.
9+
NodeJS 10+ or browser with ES2015 support.
1010

1111
## Features
1212

@@ -66,7 +66,7 @@ interface KeyValue {
6666
type ComparatorFunction = (a: KeyValue, b: KeyValue) => number;
6767
```
6868

69-
For example, to sort on the object key names in reverse order:
69+
For example, to sort by the object keys in reverse order:
7070

7171
```js
7272
var stringify = require("quick-stable-stringify");
@@ -84,7 +84,7 @@ which results in the output string:
8484
{"c":8,"b":[{"z":6,"y":5,"x":4},7],"a":3}
8585
```
8686

87-
To sort on the object values in reverse order:
87+
To sort by the object values in reverse order:
8888

8989
```js
9090
var stringify = require("quick-stable-stringify");
@@ -110,7 +110,7 @@ TypeError will be thrown in case of circular object without this option.
110110

111111
## Benchmark
112112

113-
To run benchmark (requires Node.js 6+):
113+
To run benchmark (requires Node.js 10+):
114114

115115
```
116116
node benchmark
@@ -129,7 +129,8 @@ The fastest is quick-stable-stringify
129129

130130
## Security contact
131131

132-
[sxwei123](mailto:[email protected])
132+
133+
133134
Please do NOT report security vulnerability via GitHub issues.
134135

135136
## License

0 commit comments

Comments
 (0)