Skip to content

Commit 4998d25

Browse files
committed
Updating readme requirements and adding a note on MainActor
1 parent 1838481 commit 4998d25

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,10 @@ $hasHapticsEnabled.toggle()
255255

256256
The `@SecurelyStoredValue` property wrapper can do everything a `@StoredValue` does, but instead of storing values in `UserDefaults` a `@SecurelyStoredValue` will persist items in the system's Keychain. This is perfect for storing sensitive values such as passwords or auth tokens, which you would not want to store in `UserDefaults`.
257257

258+
### A Note on `@MainActor`
259+
260+
You may have noticed that the `Store`, `StoredValue`, and `SecurelyStoredValue` are bound to the `@MainActor`. This may seem like it could cause performance issues, but I'm confident that is not the case Boutique or apps using Boutique. For additional details check out the documentation [here](https://mergesort.github.io/Boutique/documentation/boutique/using-stores/#Your-Favorite-Actor-%F0%9F%91%A9%F0%9F%8F%BB%E2%80%8D%F0%9F%8E%A4), but I wanted to make sure you feel confident that I have deeply considered this choice, talked through the choice with Swift Concurrency experts, and have tested to make sure there are no performance implications.
261+
258262
### Documentation
259263

260264
If you have any questions I would ask that you please look at the documentation first, both Boutique and Bodega are very heavily documented. On top of that Boutique comes with not one but two demo apps, each serving a different purpose but demonstrating how you can build a Boutique-backed app.
@@ -296,9 +300,9 @@ This project provides multiple ways to deliver feedback to maintainers.
296300

297301
### Requirements
298302

299-
- iOS 13.0+
300-
- macOS 11.0+
301-
- Xcode 13.2+
303+
- iOS 17.0+
304+
- macOS 14.0+
305+
- Xcode 15+
302306

303307
### Installation
304308

0 commit comments

Comments
 (0)