From 3408263c2a526b9319fe4b7cdfc0d470e4bab48d Mon Sep 17 00:00:00 2001 From: Mathew Polzin Date: Thu, 3 Jan 2019 22:09:43 -0800 Subject: [PATCH] Add warning note to README --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index bb0ec79..87a69f3 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@ A Swift package for encoding to- and decoding from **JSON API** compliant reques See the JSON API Spec here: https://jsonapi.org/format/ +:warning: Although I find the type-safety of this framework appealing, the Swift compiler currently has enough trouble with it that it can become difficult to reason about errors produced by small typos. Similarly, auto-complete fails to provide reasonable suggestions much of the time. If you get the code right, everything compiles, otherwise it can suck to figure out what is wrong. This is mostly a concern when creating entities in-code (servers and test suites must do this). Writing a client that uses this framework to ingest JSON API Compliant API responses is much less painful. :warning: + ## Table of Contents