Skip to content

Unify the canonical golden snippet across README, AGENTS, llms.txt #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fabioknoedt merged 1 commit into from
Apr 25, 2026
Merged

Unify the canonical golden snippet across README, AGENTS, llms.txt #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Fully `@objc`-compatible, so Objective-C call sites work unchanged.
import YCFirstTime

YCFirstTime.shared.executeOnce({
showOnboarding()
// your one-time code, e.g. showOnboarding()
}, forKey: "onboarding.v1")
```

Expand Down
11 changes: 9 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,14 @@ State persists to `UserDefaults`.
- **Thread safety:** Not concurrent-safe per key. Call on the main thread.
- **Hosted API docs:** [swiftpackageindex.com/fabioknoedt/YCFirstTime/documentation/ycfirsttime](https://swiftpackageindex.com/fabioknoedt/YCFirstTime/documentation/ycfirsttime)

```swift
import YCFirstTime

YCFirstTime.shared.executeOnce({
// your one-time code, e.g. showOnboarding()
}, forKey: "onboarding.v1")
```

## Copy-paste integration

### 1. Add the dependency
Expand Down Expand Up @@ -60,9 +68,8 @@ No `use_frameworks!` required.
```swift
import YCFirstTime

// Onboarding that runs exactly once per install.
YCFirstTime.shared.executeOnce({
showOnboarding()
// your one-time code, e.g. showOnboarding()
}, forKey: "onboarding.v1")
```

Expand Down