Skip to content

Commit dc1dacd

Browse files
committed
📝 Docs: Update README
1 parent d5b68b4 commit dc1dacd

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
## 🚧⚠️ Library + Documentation Re-Write WIP ⚠️🚧
99

10-
📝 Check [`TODO.md`](docs/TODO.md) for progress on re-write.
10+
📝 Note: See [Installation - Expo Modules Re-Write](#Installation-Expo-Modules-Re-Write) to try out the new version (and check [`TODO.md`](docs/TODO.md) for progress on re-write).
1111

1212
* ❤️ Support the new API's introduced in iOS 15/16+.
1313
* 🧡 New `SFSymbols` + menu icon config API (with support for advanced customizations).
@@ -22,9 +22,7 @@
2222
- Some of the links in the documentation are broken (i.e. the URL points to `PLACE_HOLDER_LINK`).
2323
- For now, please see the [Usage And Examples](#e-usage-and-examples) section, and [Showcase, Tests and Demos](#F-Showcase-Tests-and-Demos) section for information on how to use this library.
2424

25-
<br>
26-
27-
<br>
25+
<br><br>
2826

2927
| Notice |
3028
| ------------------------------------------------------------ |
@@ -197,6 +195,24 @@ cd ios && pod install
197195

198196
<br>
199197

198+
### Installation (Expo Modules Re-Write)
199+
200+
```sh
201+
# 1. install library + dependencies
202+
npm install react-native-ios-utilties@next
203+
npm install react-native-ios-context-menu@next
204+
205+
206+
# 2. then run pod install (uses auto-linking)
207+
cd ios && pod install
208+
```
209+
210+
<br>
211+
212+
📝 **Note**: This version of the library uses expo-modules (so it's compatible w/ fabric/JSI). Please remember that the re-write is currently in progress, so it might not be ready.
213+
214+
<br>
215+
200216
### Expo
201217

202218
- ✅ You can use this library with [Development Builds](https://docs.expo.dev/development/introduction/). No config plugin is required.

0 commit comments

Comments
 (0)