Skip to content
This repository has been archived by the owner on Oct 23, 2019. It is now read-only.

Commit

Permalink
better comment to avoid pointless flames
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrea Giammarchi committed Mar 13, 2013
1 parent c9c3e3a commit 6eb2b8c
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Expand Up @@ -3,7 +3,6 @@ CircularJSON

[![build status](https://secure.travis-ci.org/WebReflection/circular-json.png)](http://travis-ci.org/WebReflection/circular-json)


### A Working Solution To A Common Problem
A usage example:

Expand All @@ -17,6 +16,8 @@ object.obj = object;

var serialized = CircularJSON.stringify(object);
// '{"arr":["~","~","~arr"],"obj":"~"}'
// NOTE: CircularJSON DOES NOT parse JS
// it handles receiver and reviver callbacks

var unserialized = CircularJSON.parse(serialized);
// { arr: [ [Circular], [Circular] ],
Expand Down

0 comments on commit 6eb2b8c

Please sign in to comment.