Improve document

Author: sxwei123

README.md

@@ -1,58 +1,55 @@
-# fast-json-stable-stringify
+# quick-stable-stringify
 
-Deterministic `JSON.stringify()` - a faster version of [@substack](https://github.com/substack)'s json-stable-strigify without [jsonify](https://github.com/substack/jsonify).
+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.
 
-You can also pass in a custom comparison function.
+## Install
 
-[![Build Status](https://travis-ci.org/epoberezkin/fast-json-stable-stringify.svg?branch=master)](https://travis-ci.org/epoberezkin/fast-json-stable-stringify)
-[![Coverage Status](https://coveralls.io/repos/github/epoberezkin/fast-json-stable-stringify/badge.svg?branch=master)](https://coveralls.io/github/epoberezkin/fast-json-stable-stringify?branch=master)
+With npm do:
 
-# example
-
-``` js
-var stringify = require('fast-json-stable-stringify');
-var obj = { c: 8, b: [{z:6,y:5,x:4},7], a: 3 };
-console.log(stringify(obj));
+```
+npm install quick-stable-stringify
 ```
 
-output:
+Or install with yarn:
 
 ```
-{"a":3,"b":[{"x":4,"y":5,"z":6},7],"c":8}
+yarn add quick-stable-stringify
 ```
 
+## Examples
 
-# methods
-
-``` js
-var stringify = require('fast-json-stable-stringify')
+```js
+var stringify = require("quick-stable-stringify");
+var obj = { c: 8, b: [{ z: 6, y: 5, x: 4 }, 7], a: 3 };
+console.log(stringify(obj));
 ```
 
-## var str = stringify(obj, opts)
-
-Return a deterministic stringified string `str` from the object `obj`.
+output:
 
+```
+{"a":3,"b":[{"x":4,"y":5,"z":6},7],"c":8}
+```
 
-## options
+## Options
 
 ### cmp
 
 If `opts` is given, you can supply an `opts.cmp` to have a custom comparison
 function for object keys. Your function `opts.cmp` is called with these
 parameters:
 
-``` js
-opts.cmp({ key: akey, value: avalue }, { key: bkey, value: bvalue })
+```js
+opts.cmp({ key: akey, value: avalue }, { key: bkey, value: bvalue });
 ```
 
 For example, to sort on the object key names in reverse order you could write:
 
-``` js
-var stringify = require('fast-json-stable-stringify');
+```js
+var stringify = require("quick-stable-stringify");
 
-var obj = { c: 8, b: [{z:6,y:5,x:4},7], a: 3 };
+var obj = { c: 8, b: [{ z: 6, y: 5, x: 4 }, 7], a: 3 };
 var s = stringify(obj, function (a, b) {
-    return a.key < b.key ? 1 : -1;
+  return a.key < b.key ? 1 : -1;
 });
 console.log(s);
 ```
@@ -87,45 +84,25 @@ Pass `true` in `opts.cycles` to stringify circular property as `__cycle__` - the
 
 TypeError will be thrown in case of circular object without this option.
 
-
-# install
-
-With [npm](https://npmjs.org) do:
-
-```
-npm install fast-json-stable-stringify
-```
-
-
 # benchmark
 
 To run benchmark (requires Node.js 6+):
+
 ```
 node benchmark
 ```
 
 Results:
+
 ```
-fast-json-stable-stringify x 17,189 ops/sec ±1.43% (83 runs sampled)
-json-stable-stringify x 13,634 ops/sec ±1.39% (85 runs sampled)
-fast-stable-stringify x 20,212 ops/sec ±1.20% (84 runs sampled)
-faster-stable-stringify x 15,549 ops/sec ±1.12% (84 runs sampled)
-The fastest is fast-stable-stringify
+quick-stable-stringify x 25,499 ops/sec ±1.79% (82 runs sampled)
+fast-json-stable-stringify x 18,566 ops/sec ±0.43% (89 runs sampled)
+json-stable-stringify x 14,453 ops/sec ±0.62% (88 runs sampled)
+fast-stable-stringify x 20,763 ops/sec ±0.58% (88 runs sampled)
+faster-stable-stringify x 18,320 ops/sec ±0.90% (88 runs sampled)
+The fastest is quick-stable-stringify
 ```
 
-
-## Enterprise support
-
-fast-json-stable-stringify package is a part of [Tidelift enterprise subscription](https://tidelift.com/subscription/pkg/npm-fast-json-stable-stringify?utm_source=npm-fast-json-stable-stringify&utm_medium=referral&utm_campaign=enterprise&utm_term=repo) - it provides a centralised commercial support to open-source software users, in addition to the support provided by software maintainers.
-
-
-## Security contact
-
-To report a security vulnerability, please use the
-[Tidelift security contact](https://tidelift.com/security).
-Tidelift will coordinate the fix and disclosure. Please do NOT report security vulnerability via GitHub issues.
-
-
 # license
 
 [MIT](https://github.com/epoberezkin/fast-json-stable-stringify/blob/master/LICENSE)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "quick-stable-stringify",
-  "version": "1.0.0",
+  "version": "0.0.1",
   "description": "Deterministic `JSON.stringify()` - a faster version of Evgeny's fast-json-stable-strigify. Built with Typescript and modern Javascript.",
   "main": "./dist/index.js",
   "exports": "./dist/index.js",