Skip to content

Commit 412a9e7

Browse files
committed
Chore: Update README
1 parent c08ab4f commit 412a9e7

File tree

1 file changed

+20
-9
lines changed

1 file changed

+20
-9
lines changed

README.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,31 @@
1-
# JSON->URL
2-
[![License: MIT](https://img.shields.io/github/license/jsonurl/jsonurl-js.svg?label=License)](https://opensource.org/licenses/MIT)
1+
# JSON→URL
2+
[![License: MIT](https://img.shields.io/github/license/jsonurl/jsonurl-js.svg?label=License)][license]
33

44
## About
5-
RFC8259 describes the JSON data model and interchange format, which is widely
5+
[RFC8259][RFC8259] describes the JSON data model and interchange format, which is widely
66
used in application-level protocols including RESTful APIs. It is common for
7-
applications to request resources via the HTTP POST method, with JSON entities,
8-
however, POST is suboptimal for requests which do not modify a resource's
9-
state. JSON->URL defines a text format for the JSON data model suitable for use
10-
within a URL/URI (as described by RFC3986).
7+
applications to request resources via the HTTP POST method, with JSON entities.
8+
However, POST is suboptimal for requests which do not modify a resource's
9+
state. JSON→URL defines a text format for the JSON data model suitable
10+
for use within a [URL][RFC1738]/[URI][RFC3986].
1111

1212
## The JavaScript API
13-
JSON->URL is available as a commonjs module (suitable for use in Node), ES6
13+
JSON→URL is available as a commonjs module (suitable for use in Node), ES6
1414
module, or a script that may be used directly in a browser. The API is the
1515
same for all three.
1616
```js
1717
let p = new JsonURL();
1818
let value = p.parse( "(Hello:World!)" );
1919
```
20-
There are options available, but that's all you need to get started.
20+
There are options available, but that's all you need to get started.
21+
22+
## Security
23+
The parser is designed to parse untrusted input. It supports limits on
24+
the number of parsed values and depth of nested arrays or objects.
25+
When the limit is exceeded an Error is thrown, and sane limit values are
26+
set by default.
27+
28+
[RFC8259]: https://tools.ietf.org/html/rfc8259
29+
[RFC3986]: https://tools.ietf.org/html/rfc3986
30+
[RFC1738]: https://tools.ietf.org/html/rfc1738
31+
[license]: https://opensource.org/licenses/MIT

0 commit comments

Comments
 (0)