You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 11, 2024. It is now read-only.
| Linux | 5.1 |[Swift Package Manager](#swift-package-manager)| Fully Tested |
31
31
| Windows | 5.1 |[Swift Package Manager](#swift-package-manager)| Not Tested but Supported |
32
32
@@ -40,6 +40,12 @@ The data types, protocols, and property wrappers defined by **DynamicCodableKit*
40
40
pod 'DynamicCodableKit'
41
41
```
42
42
43
+
Optionally, you can also use the pre built XCFramework from the GitHub releases page by replacing `{version}` with the required version you want to use:
44
+
45
+
```ruby
46
+
pod 'DynamicCodableKit', :http => 'https://github.com/SwiftyLab/DynamicCodableKit/releases/download/v{version}/DynamicCodableKit-{version}.xcframework.zip'
47
+
```
48
+
43
49
### Carthage
44
50
45
51
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. To integrate `DynamicCodableKit` into your Xcode project using Carthage, specify it in your `Cartfile`:
@@ -55,11 +61,56 @@ The [Swift Package Manager](https://swift.org/package-manager/) is a tool for au
55
61
Once you have your Swift package set up, adding `DynamicCodableKit` as a dependency is as easy as adding it to the `dependencies` value of your `Package.swift`.
Optionally, you can also use the pre built XCFramework from the GitHub releases page by replacing `{version}` and `{checksum}` with the required version and checksum of artifact you want to use:
If you prefer not to use any of the aforementioned dependency managers, you can integrate `DynamicCodableKit` into your project manually.
76
+
77
+
#### Git Submodule
78
+
79
+
- Open up Terminal, `cd` into your top-level project directory, and run the following command "if" your project is not initialized as a git repository:
80
+
81
+
```bash
82
+
$ git init
83
+
```
84
+
85
+
- Add `DynamicCodableKit` as a git [submodule](https://git-scm.com/docs/git-submodule) by running the following command:
- Open the new `DynamicCodableKit` folder, and drag the `DynamicCodableKit.xcodeproj` into the Project Navigator of your application's Xcode project or existing workspace.
92
+
93
+
> It should appear nested underneath your application's blue project icon. Whether it is above or below all the other Xcode groups does not matter.
94
+
95
+
- Select the `DynamicCodableKit.xcodeproj` in the Project Navigator and verify the deployment target satisfies that of your application target (should be less or equal).
96
+
- Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the `Targets` heading in the sidebar.
97
+
- In the tab bar at the top of that window, open the "General" panel.
98
+
- Click on the `+` button under the `Frameworks and Libraries` section.
99
+
- You will see `DynamicCodableKit.xcodeproj` folder with `DynamicCodableKit.framework` nested inside.
100
+
- Select the `DynamicCodableKit.framework` and that's it!
101
+
102
+
> The `DynamicCodableKit.framework` is automagically added as a target dependency, linked framework and embedded framework in build phase which is all you need to build on the simulator and a device.
103
+
104
+
#### XCFramework
105
+
106
+
You can also directly download the pre-built artifact from the GitHub releases page:
107
+
108
+
- Download the artifact from the GitHub releases page of the format `DynamicCodableKit-{version}.xcframework.zip` where `{version}` is the version you want to use.
109
+
- Extract the XCFramework from the archive, and drag the `DynamicCodableKit.xcframework` into the Project Navigator of your application's target folder in your Xcode project.
110
+
- Select `Copy items if needed` and that's it!
111
+
112
+
> The `DynamicCodableKit.xcframework` is automagically added in the embedded `Frameworks and Libraries` section, an in turn the linked framework in build phase.
113
+
63
114
## Usage
64
115
65
116
See the full [documentation](https://swiftylab.github.io/DynamicCodableKit/documentation/dynamiccodablekit/) for API details and articles on sample scenarios.
| Linux | 5.1 | Swift Package Manager | Fully Tested |
18
18
| Windows | 5.1 | Swift Package Manager | Not Tested but Supported |
19
19
@@ -27,6 +27,12 @@ The data types, protocols, and property wrappers defined by `DynamicCodableKit`
27
27
pod 'DynamicCodableKit'
28
28
```
29
29
30
+
Optionally, you can also use the pre built XCFramework from the GitHub releases page by replacing `{version}` with the required version you want to use:
31
+
32
+
```ruby
33
+
pod 'DynamicCodableKit', :http => 'https://github.com/SwiftyLab/DynamicCodableKit/releases/download/v{version}/DynamicCodableKit-{version}.xcframework.zip'
34
+
```
35
+
30
36
### Carthage
31
37
32
38
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. To integrate `DynamicCodableKit` into your Xcode project using Carthage, specify it in your `Cartfile`:
@@ -42,11 +48,56 @@ The [Swift Package Manager](https://swift.org/package-manager/) is a tool for au
42
48
Once you have your Swift package set up, adding `DynamicCodableKit` as a dependency is as easy as adding it to the `dependencies` value of your `Package.swift`.
Optionally, you can also use the pre built XCFramework from the GitHub releases page by replacing `{version}` and `{checksum}` with the required version and checksum of artifact you want to use:
If you prefer not to use any of the aforementioned dependency managers, you can integrate `DynamicCodableKit` into your project manually.
63
+
64
+
#### Git Submodule
65
+
66
+
- Open up Terminal, `cd` into your top-level project directory, and run the following command "if" your project is not initialized as a git repository:
67
+
68
+
```bash
69
+
$ git init
70
+
```
71
+
72
+
- Add `DynamicCodableKit` as a git [submodule](https://git-scm.com/docs/git-submodule) by running the following command:
- Open the new `DynamicCodableKit` folder, and drag the `DynamicCodableKit.xcodeproj` into the Project Navigator of your application's Xcode project or existing workspace.
79
+
80
+
> It should appear nested underneath your application's blue project icon. Whether it is above or below all the other Xcode groups does not matter.
81
+
82
+
- Select the `DynamicCodableKit.xcodeproj` in the Project Navigator and verify the deployment target satisfies that of your application target (should be less or equal).
83
+
- Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the `Targets` heading in the sidebar.
84
+
- In the tab bar at the top of that window, open the "General" panel.
85
+
- Click on the `+` button under the `Frameworks and Libraries` section.
86
+
- You will see `DynamicCodableKit.xcodeproj` folder with `DynamicCodableKit.framework` nested inside.
87
+
- Select the `DynamicCodableKit.framework` and that's it!
88
+
89
+
> The `DynamicCodableKit.framework` is automagically added as a target dependency, linked framework and embedded framework in build phase which is all you need to build on the simulator and a device.
90
+
91
+
#### XCFramework
92
+
93
+
You can also directly download the pre-built artifact from the GitHub releases page:
94
+
95
+
- Download the artifact from the GitHub releases page of the format `DynamicCodableKit-{version}.xcframework.zip` where `{version}` is the version you want to use.
96
+
- Extract the XCFramework from the archive, and drag the `DynamicCodableKit.xcframework` into the Project Navigator of your application's target folder in your Xcode project.
97
+
- Select `Copy items if needed` and that's it!
98
+
99
+
> The `DynamicCodableKit.xcframework` is automagically added in the embedded `Frameworks and Libraries` section, an in turn the linked framework in build phase.
0 commit comments