Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KilledByAPixel authored Feb 16, 2022
1 parent e317d05 commit 4376ec3
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ This simple system allows for excellent compression of uri encoded JSON strings
* Download from github or use `npm install jsoncrush`
* Import JSONCrush as a module with something like `import JSONCrush from './JSONCrush.js'`
* Just pass a JSON string to `JSONCrush.crush()` to compress it!
* If used in a url you must call `encodeURIComponent()` to escape any special characters.
* To decode just pass the crushed string to `JSONCrush.uncrush()`
* See [index.html](https://github.com/KilledByAPixel/JSONCrush/blob/master/index.html) for a demonstration.

Expand Down

0 comments on commit 4376ec3

Please sign in to comment.