From 19d375fe6571425319953a6ff1092258afa9ebff Mon Sep 17 00:00:00 2001 From: Dominic Go <18517029+dominicstop@users.noreply.github.com> Date: Sun, 21 Nov 2021 06:34:10 +0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20`README`?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d66b2be..47fc421 100644 --- a/README.md +++ b/README.md @@ -18,11 +18,12 @@
-📝 **Note**: A future major version of this library will introduce breaking changes to the API (mainly just renaming some of the properties) in order to add new features. +| Notice | +| ------------------------------------------------------------ | +| 📝 **Note** #1: A future major version of this library will introduce breaking changes to the API (mainly just renaming some of the properties) in order to add new features (and better types).

However, the next minor version of this library will not introduce any breaking changes but will instead focus on adding typescript annotations and fixing the existing bugs, but will require your project/app to be built with Xcode 13.1. | +| 📝 **Note** #2: The documentation + examples are currently being rewritten.

💅 [`README-next.md`](./README-next.md) — The new version of the documentation (WIP).
💖 [`example/src/examples`](./example/src/examples) — The typescript rewrite of the examples (WIP). | -However, the next minor version of this library will not introduce any breaking changes but will instead focus on adding typescript annotations and fixing the existing bugs, but will require your project/app to be built with Xcode 13.1. - -
+ ()
### Versions