From dc6d33feea3d23b79c7c9ee03b5ea096665640d9 Mon Sep 17 00:00:00 2001
From: Dominic Go <dominic@dominicgo.dev>
Date: Sun, 22 Sep 2024 02:19:32 +0800
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Docs:=20Update=20README?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 34 +++++++++++-----------------------
 1 file changed, 11 insertions(+), 23 deletions(-)

diff --git a/README.md b/README.md
index d2e505c0..0920c5eb 100644
--- a/README.md
+++ b/README.md
@@ -1,31 +1,19 @@
 # react-native-ios-modal
 
-TBA
+## 🚧⚠️ Re-Write in Progress ⚠️🚧
 
-## Installation
+hello, this library is being re-written — please see the [`v2.x`](https://github.com/dominicstop/react-native-ios-modal/tree/v2.x) branch for the older version of this library + it's corresponding documentation.
 
-```sh
-npm install react-native-ios-modal
-```
-
-## Usage
+* Support for iOS 15 sheet detents, and iOS 16 custom detents (+ all the related sheet-related customizations and events).
+* Typescript re-write for better auto-complete.
+* Streamlining the modal-related events, and exposing more events.
+* Better iPad support.
+* Etc.
 
-```js
-import { IosModalView } from "react-native-ios-modal";
+<br><br>
 
-// ...
+Try out the wip version of the library:
 
-<IosModalView color="tomato" />
 ```
-
-## Contributing
-
-See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
-
-## License
-
-MIT
-
----
-
-Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)
+npm install react-native-ios-modal@next
+```