Skip to content

Commit 74f3a51

Browse files
authored
Update Documentation
1 parent ed0b3c4 commit 74f3a51

File tree

1 file changed

+5
-14
lines changed

1 file changed

+5
-14
lines changed

Readme.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<p align="center">
22
<img src="Documents/header.png" srcset="Documents/header.png 1x Documents/[email protected] 2x" /><br/>
3-
<a href="https://swift.org"><img src="https://img.shields.io/badge/Swift-3-orange.svg" /></a>
3+
<a href="https://swift.org"><img src="https://img.shields.io/badge/Swift-5-orange.svg" /></a>
44
<a href="https://github.com/Carthage/Carthage"><img src="https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat" /></a>
55
<a href="https://cocoapods.org"><img src="https://img.shields.io/cocoapods/v/CoreValue.svg" /></a>
66
<img src="https://img.shields.io/cocoapods/p/CoreValue.svg" />
@@ -15,18 +15,14 @@
1515
- iOS and Mac OS X support
1616
- Use with `structs`
1717
- Works fine with `let` and `var` based properties
18-
- Swift 3.0
19-
- (for Swift 2.3, use the [swift2.3" branch](https://github.com/terhechte/CoreValue/tree/swift2.3))
20-
- (for Swift 2.2 use [Version 0.2](https://github.com/terhechte/CoreValue/releases/tag/v0.2.0))
18+
- Swift 5.0
2119

2220
## Rationale
2321

2422
Swift introduced versatile value types into the iOS and Cocoa development domains. They're lightweight, fast, safe, enforce immutability and much more. However, as soon as the need for CoreData in a project manifests itself, we have to go back to reference types and `@objc`.
2523

2624
CoreValue is a lightweight wrapper framework around Core Data. It takes care of `boxing` value types into Core Data objects and `unboxing` Core Data objects into value types. It also contains simple abstractions for easy querying, updating, saving, and deleting.
2725

28-
If you're porting your app to Swift 3, please see the Swift 3 section at the bottom.
29-
3026
## Usage
3127

3228
The following struct supports boxing, unboxing, and keeping object state:
@@ -374,14 +370,6 @@ All CoreData Datatypes are supported, with the following **exceptions**:
374370

375371
Fetched properties are not supported yet.
376372

377-
## Swift 3.0 Conversion
378-
379-
The Swift 3.0 conversion changed a few things within the framework. In order to make it easier, here's a list of things to do:
380-
381-
1. Replace `<*>` operators with `<^>`
382-
2. Replace `func fromObject(object)` with `func fromObject(_ object)`
383-
3. Replace `return curry(self.init)...` with `return try curry(self.init)...`
384-
385373
## Installation (iOS and macOS)
386374

387375
### [CocoaPods]
@@ -439,6 +427,9 @@ Benedikt Terhechte
439427

440428
## Changelog
441429

430+
### Version 0.4.0
431+
- Swift 5 Support thanks to [DaGerry](https://github.com/DaGerry)
432+
442433
### Version 0.3.0
443434
- Swift 3 Support
444435
- Added CVManagedUniqueStruct thanks to [tkohout](https://github.com/tkohout)

0 commit comments

Comments
 (0)