Skip to content

Commit 1d67bc7

Browse files
dominicstopdominicstop
committed
📝 Docs: Update README-01-Pre 
1 parent 34452bc commit 1d67bc7

File tree

2 files changed

+43
-17
lines changed

2 files changed

+43
-17
lines changed

‎README.md‎

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,17 @@
1818

1919
| Notice |
2020
| ------------------------------------------------------------ |
21-
| 📝 **Note** #1: Staring on version `2.x`, this library now uses `expo-modules`, and contains a peer dependency to `react-native-ios-utilites`. |
22-
| 📝 **Note** #2: The documentation + examples are currently being rewritten.<br><br>💅 [`README-old-v1.md`](./README-old-v1.md) — The old version of the documentation (archived).<br>💖 [`example/src/examples`](./example/src/examples) — The typescript rewrite of the examples (WIP). |
21+
| 📝 **Note** #1: Version `3.x` is a rewrite of this library to support both fabric (the new architecture), and offer backwards compatibility to paper (the old architecture).<br><br> The support for both paper and fabric is possible via a peer dependency to [`react-native-ios-utilites@v5`](https://github.com/dominicstop/react-native-ios-utilities). |
22+
| 📝 **Note** #2: The documentation + examples are currently being rewritten.<br><br>❤️ [`README-old-v1.md`](./README-old-v1.md) — Documentation for `v1.x`<br>🧡 [`README-old-v2.md`](./README-old-v2.md) — Documentation for `v2.x`<br>💛 [`example/src/examples`](./example/src/examples) — The typescript rewrite of the examples (WIP). |
2323

2424
<br>
2525

2626
### Versions
2727

2828
| Library Version | Compatibility |
2929
| :-------------- | ------------------------------------------------------------ |
30-
| `2.1`+ | Uses `Expo-Modules`<br/>Depends on `react-native-ios-utilities@4.x`<br/>Depends on `ContextMenuAuxiliaryPreview`<br>iOS 13+<br/>Xcode 15+ |
30+
| `3.x`+ | Depends on `react-native-ios-utilities@5.x`<br/>iOS 13+<br/>Xcode 15+` |
31+
| `2.1` | Uses `Expo-Modules`<br/>Depends on `react-native-ios-utilities@4.x`<br/>Depends on `ContextMenuAuxiliaryPreview`<br>iOS 13+<br/>Xcode 15+ |
3132
| `2.0.x` | Uses `Expo-Modules`<br>Depends on `react-native-ios-utilities@4.x`<br>iOS 13+<br>Xcode 15+ |
3233
| `1.6.2` | iOS 10 to iOS 15<br>Xcode 12+ |
3334
| `1.4` | iOS 10 to iOS 15<br>Xcode 13+ |
@@ -106,6 +107,18 @@
106107

107108
<br><br>
108109

110+
### Acknowledgements
111+
112+
The initial fabric rewrite (i.e. version `5.x`) was made possible through a generous `$3,250` sponsorship by [natew](https://github.com/natew) + [tamagui](https://github.com/tamagui/tamagui) over the course of ≈ 3.5 months (from: `05/27/24` to `09/24`) 🐦✨
113+
114+
<br>
115+
116+
Very special thanks to: [junzhengca](https://github.com/junzhengca), [brentvatne](https://github.com/brentvatne), and [expo](https://github.com/expo) for sponsoring my work 🥺
117+
118+
<br><br>
119+
120+
<br><br>
121+
109122
## A. Introduction
110123

111124
A react native component to use [`UIMenu`](https://developer.apple.com/documentation/uikit/uimenu) on iOS 13 and later.
@@ -172,8 +185,8 @@ A react native component to use [`UIMenu`](https://developer.apple.com/documenta
172185

173186
```sh
174187
# 1. install library + dependencies
175-
npm install react-native-ios-utilities
176-
npm install react-native-ios-context-menu
188+
npm install react-native-ios-utilities@next
189+
npm install react-native-ios-context-menu@next
177190

178191
# 2. then run pod install (uses auto-linking)
179192
cd ios && pod install
@@ -208,11 +221,12 @@ cd ios && pod install
208221

209222
### Updating
210223

211-
This library has cocoapods dependency to [`ContextMenuAuxiliaryPreview`](https://github.com/dominicstop/ContextMenuAuxiliaryPreview), so you need to update it separately.
224+
This library has cocoapods dependency to [`ContextMenuAuxiliaryPreview`](https://github.com/dominicstop/ContextMenuAuxiliaryPreview) and [`DGSwiftUtilities`](https://github.com/dominicstop/DGSwiftUtilities), so you may need to update them separately (as needed).
212225

213226
```sh
214227
# A. Either update this specific pod...
215-
pod update ContextMenuAuxiliaryPreview
228+
pod update ContextMenuAuxiliaryPreview DGSwiftUtilities
229+
pod install --repo-update
216230

217231
# B. Or update all the pods
218232
pod update

‎docs/README-01-Pre.md‎

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,22 @@
1818

1919
| Notice |
2020
| ------------------------------------------------------------ |
21-
| 📝 **Note** #1: Staring on version `2.x`, this library now uses `expo-modules`, and contains a peer dependency to `react-native-ios-utilites`. |
22-
| 📝 **Note** #2: The documentation + examples are currently being rewritten.<br><br>💅 [`README-old-v1.md`](./README-old-v1.md) — The old version of the documentation (archived).<br>💖 [`example/src/examples`](./example/src/examples) — The typescript rewrite of the examples (WIP). |
21+
| 📝 **Note** #1: Version `3.x` is a rewrite of this library to support both fabric (the new architecture), and offer backwards compatibility to paper (the old architecture).<br><br> The support for both paper and fabric is possible via a peer dependency to [`react-native-ios-utilites@v5`](https://github.com/dominicstop/react-native-ios-utilities). |
22+
| 📝 **Note** #2: The documentation + examples are currently being rewritten.<br><br>❤️ [`README-old-v1.md`](./README-old-v1.md) — Documentation for `v1.x`<br>🧡 [`README-old-v2.md`](./README-old-v2.md) — Documentation for `v2.x`<br>💛 [`example/src/examples`](./example/src/examples) — The typescript rewrite of the examples (WIP). |
2323

2424
<br>
2525

2626
### Versions
2727

2828
| Library Version | Compatibility |
2929
| :-------------- | ------------------------------------------------------------ |
30-
| `2.1`+ | Uses `Expo-Modules`<br/>Depends on `react-native-ios-utilities@4.x`<br/>Depends on `ContextMenuAuxiliaryPreview`<br>iOS 13+<br/>Xcode 15+ |
30+
| `3.x`+ | Depends on `react-native-ios-utilities@5.x`<br/>iOS 13+<br/>Xcode 15+` |
31+
| `2.1` | Uses `Expo-Modules`<br/>Depends on `react-native-ios-utilities@4.x`<br/>Depends on `ContextMenuAuxiliaryPreview`<br>iOS 13+<br/>Xcode 15+ |
3132
| `2.0.x` | Uses `Expo-Modules`<br>Depends on `react-native-ios-utilities@4.x`<br>iOS 13+<br>Xcode 15+ |
3233
| `1.6.2` | iOS 10 to iOS 15<br>Xcode 12+ |
3334
| `1.4` | iOS 10 to iOS 15<br>Xcode 13+ |
3435
| `1.3` and Below | iOS 10 to 14<br>Xcode 12+ |
3536

36-
📝 **Note**: Supports projects targeting iOS 10 but will use the action sheet fallback when running on iOS 12 and older.
37-
3837
<br><br>
3938

4039
## Table of Contents
@@ -106,6 +105,18 @@
106105

107106
<br><br>
108107

108+
### Acknowledgements
109+
110+
The initial fabric rewrite (i.e. version `5.x`) was made possible through a generous `$3,250` sponsorship by [natew](https://github.com/natew) + [tamagui](https://github.com/tamagui/tamagui) over the course of ≈ 3.5 months (from: `05/27/24` to `09/24`) 🐦✨
111+
112+
<br>
113+
114+
Very special thanks to: [junzhengca](https://github.com/junzhengca), [brentvatne](https://github.com/brentvatne), and [expo](https://github.com/expo) for sponsoring my work 🥺
115+
116+
<br><br>
117+
118+
<br><br>
119+
109120
## A. Introduction
110121

111122
A react native component to use [`UIMenu`](https://developer.apple.com/documentation/uikit/uimenu) on iOS 13 and later.
@@ -172,8 +183,8 @@ A react native component to use [`UIMenu`](https://developer.apple.com/documenta
172183

173184
```sh
174185
# 1. install library + dependencies
175-
npm install react-native-ios-utilities
176-
npm install react-native-ios-context-menu
186+
npm install react-native-ios-utilities@next
187+
npm install react-native-ios-context-menu@next
177188

178189
# 2. then run pod install (uses auto-linking)
179190
cd ios && pod install
@@ -208,11 +219,12 @@ cd ios && pod install
208219

209220
### Updating
210221

211-
This library has cocoapods dependency to [`ContextMenuAuxiliaryPreview`](https://github.com/dominicstop/ContextMenuAuxiliaryPreview), so you need to update it separately.
222+
This library has cocoapods dependency to [`ContextMenuAuxiliaryPreview`](https://github.com/dominicstop/ContextMenuAuxiliaryPreview) and [`DGSwiftUtilities`](https://github.com/dominicstop/DGSwiftUtilities), so you may need to update them separately (as needed).
212223

213224
```sh
214225
# A. Either update this specific pod...
215-
pod update ContextMenuAuxiliaryPreview
226+
pod update ContextMenuAuxiliaryPreview DGSwiftUtilities
227+
pod install --repo-update
216228

217229
# B. Or update all the pods
218230
pod update
@@ -239,7 +251,7 @@ pod update
239251

240252
### Troubleshooting
241253

242-
If you encounter any errors/bugs while using this library, or want a particular feature implemented, please create an issue! (my inbox is a mess, please feel free to tag me). ✨
254+
If you encounter any errors/bugs while using this library, or want a particular feature implemented, please create an issue (my inbox is a mess, please feel free to tag me). ✨
243255

244256
<br>
245257

0 commit comments

Comments
 (0)