Skip to content

Commit 8f36bb4

Browse files
committed
Add note about the library being a bit 'opinionated'
1 parent 55f2f52 commit 8f36bb4

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@ The primary goals of this framework are:
1313
3. Do not sacrifice type safety.
1414
4. Be platform agnostic so that Swift code can be written once and used by both the client and the server.
1515

16+
### Caveat
17+
The big caveat is that, although the aim is to support the JSON API spec, this framework ends up being _naturally_ opinionated about certain things that the API Spec does not specify. These caveats are largely a side effect of attempting to write the library in a "Swifty" way.
18+
19+
If you find that something in the JSON API v1.0 Spec is not explicitly missing from the **Project Status** checklist but this library does not support it, please let me know! I want to keep working towards a library implementation that is useful in any application.
20+
1621
## Dev Environment
1722
### Prerequisites
1823
1. Swift 4.2+ and Swift Package Manager

0 commit comments

Comments
 (0)