diff --git a/packages/fast-stable-stringify/README.md b/packages/fast-stable-stringify/README.md index 7c080d55c6c8..687109f62f69 100644 --- a/packages/fast-stable-stringify/README.md +++ b/packages/fast-stable-stringify/README.md @@ -7,25 +7,24 @@ The most popular repository providing this feature is [substack's json-stable-st Usage: ```javascript -var stringify = require('fast-stable-stringify'); +import stringify from '@solana/fast-stable-stringify'; stringify({ d: 0, c: 1, a: 2, b: 3, e: 4 }); // '{"a":2,"b":3,"c":1,"d":0,"e":4}' ``` Just like substack's, it does: -* handle all variations of all basic javascript values (number, string, boolean, array, object, null, Date, BigInt) -* handle undefined _and_ function in the same way as `JSON.stringify` -* **not support ie8 (and below) with complete certainty**. +- handle all variations of all basic javascript values (number, string, boolean, array, object, null, Date, BigInt) +- handle undefined _and_ function in the same way as `JSON.stringify` +- **not support ie8 (and below) with complete certainty**. Unlike substack's, it does: -* not implement the 'replacer' or 'space' arguments of the JSON.stringify method -* not check for circular references - +- not implement the 'replacer' or 'space' arguments of the JSON.stringify method +- not check for circular references ## Running tests ``` npm run test:unit:browser -npm run test:unit:node -``` \ No newline at end of file +npm run test:unit:node +```