Skip to content

Commit 68fd420

Browse files
committed
Added compatibility notice to readme
1 parent e5cb247 commit 68fd420

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,12 @@ A few ways to have a lazily-initialized value in Swift 5.1. Note that, if you ar
66
* [`Lazy`](https://github.com/RougeWare/Swift-Lazy-Patterns/blob/master/Lazy.swift#L184-L248): A non-resettable lazy pattern, to guarantee lazy behavior across Swift language versions
77
* [`ResettableLazy`](https://github.com/RougeWare/Swift-Lazy-Patterns/blob/master/Lazy.swift#L252-L330): A resettable lazy pattern, whose value is generated and cached only when first needed, and can be destroyed when no longer needed.
88
* [`FunctionalLazy`](https://github.com/RougeWare/Swift-Lazy-Patterns/blob/master/Lazy.swift#L334-L444): An idea about how to approach the lazy pattern by using functions instead of branches.
9+
10+
11+
# Compatibility Notice #
12+
13+
The API had notable changes when transitioning from 1.1.0 to 2.0.0. To ease this transition, `Lazy.swift` was left in the root of this repo.
14+
15+
Additionally, to make this a Swift Package, both `Lazy.swift` and its tests were duplicated.
16+
17+
In version 3.0.0, `Lazy.swift` will be moved to `LazyContainers/Sources/LazyContainers/LazyContainers.swift` in order to reduce this duplication. To ease that transition, you should change any hard-coded references to `Lazy.swift` to point to `LazyContainers/Sources/LazyContainers/LazyContainers.swift`.

0 commit comments

Comments
 (0)