📝 Update README

This commit is contained in:
Dominic Go 2021-11-21 06:34:10 +08:00
parent e87901f363
commit 19d375fe65

View File

@ -18,11 +18,12 @@
<br>
📝 **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). <br><br>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.<br><br>💅 [`README-next.md`](./README-next.md) — The new version of the documentation (WIP).<br>💖 [`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.
<br>
()<br>
### Versions