Skip to content

Commit 3604b5f

Browse files
committed
Update README.md
1 parent 834a28e commit 3604b5f

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
# swift-pure-json
22

3-
A description of this package.
3+
[![Swift 5.1](https://img.shields.io/badge/Swift-5.1-blue.svg)](https://swift.org/download/)
4+
[![github-actions](https://github.com/fabianfett/pure-swift-json/workflows/CI/badge.svg)](https://github.com/fabianfett/pure-swift-json/actions)
5+
[![codecov](https://codecov.io/gh/fabianfett/pure-swift-json/branch/master/graph/badge.svg)](https://codecov.io/gh/fabianfett/pure-swift-json)
6+
![macOS](https://img.shields.io/badge/os-macOS-green.svg?style=flat)
7+
![tuxOS](https://img.shields.io/badge/os-tuxOS-green.svg?style=flat)
8+
9+
This package provides a json encoder and decoder in pure Swift (without the use of Foundation).
10+
The implementation shall be [RFC8259](https://tools.ietf.org/html/rfc8259) complient.
411

5-
https://tools.ietf.org/html/rfc8259
612

713
### Goals
814

@@ -11,6 +17,18 @@ https://tools.ietf.org/html/rfc8259
1117
- [x] No external dependencies other than the Swift STL
1218
- [x] Faster than Foundation implementation
1319

14-
### Alternatives
20+
### Status
21+
22+
**Note**: Don't use this. This is under heavy development and will be changed a lot!
1523

24+
Currently the focus areas are:
25+
26+
- This needs **a lot** of tests to ensure correct working and safety against attackers
27+
- Fix all `preconditionFailure("unimplemented")`
28+
- Find a way how to allow parsing of `Date` and `Data`
29+
- Support decoding of other unicode encodings (currently only utf-8 supported)
30+
31+
### Alternatives
1632

33+
- [IkigaJSON](https://github.com/autimatisering/IkigaJSON)
34+
- [Foundation Coding](https://github.com/apple/swift-corelibs-foundation/blob/master/Sources/Foundation/JSONEncoder.swift)

0 commit comments

Comments
 (0)