Skip to content

Commit f4fec62

Browse files
committed
Update readme
1 parent ca9740c commit f4fec62

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,13 @@
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
8+
9+
NodeJS 10+ or broswer with ES2015 support.
10+
711
## Features
812

9-
- Support both browser and nodejs
13+
- Support both browser and NodeJS
1014
- Support custom comparator function
1115
- No dependencies
1216

@@ -104,7 +108,7 @@ Pass `true` in `opts.cycles` to stringify circular property as `__cycle__` - the
104108

105109
TypeError will be thrown in case of circular object without this option.
106110

107-
# benchmark
111+
## Benchmark
108112

109113
To run benchmark (requires Node.js 6+):
110114

@@ -123,6 +127,11 @@ faster-stable-stringify x 18,320 ops/sec ±0.90% (88 runs sampled)
123127
The fastest is quick-stable-stringify
124128
```
125129

126-
# license
130+
## Security contact
131+
132+
[sxwei123](mailto:[email protected])
133+
Please do NOT report security vulnerability via GitHub issues.
134+
135+
## License
127136

128-
[MIT](https://github.com/epoberezkin/fast-json-stable-stringify/blob/master/LICENSE)
137+
[MIT](https://github.com/sxwei123/quick-stable-stringify/blob/master/LICENSE)

0 commit comments

Comments
 (0)