Skip to content

Commit b4f2436

Browse files
committed
update readme
1 parent 9f7a8d3 commit b4f2436

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,17 @@ Tested with ReerJSON 0.1.0, ZippyJSON 1.2.15, IkigaJSON 2.3.2
3535
# Usage
3636
Just replace `JSONDecoder` with `ReerJSONDecoder` wherever you want to use it. So instead of `let decoder = JSONDecoder()`, do `let decoder = ReerJSONDecoder()`, and everything will just work. This is because `ReerJSONDecoder` has the exact same API as `JSONDecoder`. Also, don't forget to add `import ReerJSON` in files where you use it.
3737

38+
# Differences
39+
| Decoder Diff | Foundation |ReerJSON |
40+
|---------------------------|------------|---------------------------|
41+
| JSON5 |||
42+
| assumesTopLevelDictionary |||
43+
| Infinity and NaN | ±Infinity, ±NaN | ±Infinity, ±NaN, ±Inf and case-insensitive. See [details](https://github.com/reers/ReerJSON/blob/main/Tests/ReerJSONTests/JSONEncoderTests.swift#L1975) |
44+
3845
# TODO
3946
* [x] Add GitHub workflow for CI.
4047
* [x] Support `CodableWithConfiguration`.
41-
* [ ] Support JSON5 decoding.
48+
* [x] Support JSON5 decoding.
4249
* [ ] Implement ReerJSONEncoder.
4350

4451
# License

0 commit comments

Comments
 (0)