Skip to content

Commit

Permalink
Improve example in readme
Browse files Browse the repository at this point in the history
Call out that this is intentionally a kitchen-sink example,
and link to a nice real-world example too (Chromium/Blink config file).
  • Loading branch information
aseemk authored Oct 1, 2022
1 parent d720b4f commit 97286f8
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,9 @@ been extended to JSON5.

[IEEE 754]: http://ieeexplore.ieee.org/servlet/opac?punumber=4610933

## Short Example
## Example
Kitchen-sink example:

```js
{
// comments
Expand All @@ -89,6 +91,9 @@ No \\n's!",
}
```

A more real-world example is [this config file](https://github.com/chromium/chromium/blob/feb3c9f670515edf9a88f185301cbd7794ee3e52/third_party/blink/renderer/platform/runtime_enabled_features.json5)
from the Chromium/Blink project.

## Specification
For a detailed explanation of the JSON5 format, please read the [official
specification](https://json5.github.io/json5-spec/).
Expand Down

0 comments on commit 97286f8

Please sign in to comment.