From 659b4e3f53084cd93ce2923de7972b072b242fb9 Mon Sep 17 00:00:00 2001
From: Pedro Augusto de Paula Barbosa <papb1996@gmail.com>
Date: Thu, 18 Apr 2019 16:48:05 -0300
Subject: [PATCH] Improve README

---
 README.md | 20 +++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index a11f302..bc1ac1d 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # json-stringify-safe
 
-Like JSON.stringify, but doesn't throw on circular references.
+Like `JSON.stringify`, but doesn't throw on circular references.
 
 ## Usage
 
@@ -18,10 +18,10 @@ Output:
 
 ```json
 {
-  "circularRef": "[Circular]",
+  "circularRef": "[Circular ~]",
   "list": [
-    "[Circular]",
-    "[Circular]"
+    "[Circular ~]",
+    "[Circular ~]"
   ]
 }
 ```
@@ -35,11 +35,13 @@ stringify(obj, serializer, indent, decycler)
 The first three arguments are the same as to JSON.stringify.  The last
 is an argument that's only used when the object has been seen already.
 
-The default `decycler` function returns the string `'[Circular]'`.
-If, for example, you pass in `function(k,v){}` (return nothing) then it
-will prune cycles.  If you pass in `function(k,v){ return {foo: 'bar'}}`,
-then cyclical objects will always be represented as `{"foo":"bar"}` in
-the result.
+The default `decycler` function returns a string like `'[Circular ~.a.b]'`
+where `~.a.b` represents where the circular reference comes from (`~` being
+the stringified object). If, for example, you pass an empty function `(k,v) => {}`
+then it will prune cycles. If you pass in `(k,v) => ({ foo: 'bar' })`, then
+cyclical objects will always be represented as `{"foo":"bar"}` in the result.
+If you pass `() => '[Circular]'`, then every circular reference will be just
+`[Circular]` without the `~`-path.
 
 ```
 stringify.getSerialize(serializer, decycler)