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
Copy file name to clipboardExpand all lines: README.md
+104Lines changed: 104 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -21,3 +21,107 @@ While Swift's modern structured concurrency provides safer way of managing concu
21
21
- Introducing traditional synchronization primitives that work in non-blocking way with ``AsyncSemaphore``, ``AsyncEvent`` and ``AsyncCountdownEvent``.
22
22
- Bridging with Grand Central Dispatch and allowing usage of GCD specific patterns with ``TaskOperation`` and ``TaskQueue``.
23
23
- Transferring data between multiple task boundaries with ``Future``.
24
+
25
+
## Requirements
26
+
27
+
| Platform | Minimum Swift Version | Installation | Status |
| Linux | 5.6 |[Swift Package Manager](#swift-package-manager)| Fully Tested |
31
+
| Windows | 5.6 |[Swift Package Manager](#swift-package-manager)| Fully Tested |
32
+
33
+
## Installation
34
+
35
+
### CocoaPods
36
+
37
+
[CocoaPods](https://cocoapods.org) is a dependency manager for Cocoa projects. For usage and installation instructions, visit their website. To integrate `AsyncObjects` into your Xcode project using CocoaPods, specify it in your `Podfile`:
38
+
39
+
```ruby
40
+
pod 'AsyncObjects'
41
+
```
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 'AsyncObjects', :http => 'https://github.com/SwiftyLab/AsyncObjects/releases/download/v{version}/AsyncObjects-{version}.xcframework.zip'
47
+
```
48
+
49
+
### Carthage
50
+
51
+
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. To integrate `AsyncObjects` into your Xcode project using Carthage, specify it in your `Cartfile`:
52
+
53
+
```ogdl
54
+
github "SwiftyLab/AsyncObjects"
55
+
```
56
+
57
+
### Swift Package Manager
58
+
59
+
The [Swift Package Manager](https://swift.org/package-manager/) is a tool for automating the distribution of Swift code and is integrated into the `swift` compiler.
60
+
61
+
Once you have your Swift package set up, adding `AsyncObjects` 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, but in this case dependencies must be added separately:
If you prefer not to use any of the aforementioned dependency managers, you can integrate `AsyncObjects` 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 `AsyncObjects` as a git [submodule](https://git-scm.com/docs/git-submodule) by running the following command:
- Open the new `AsyncObjects` folder, and drag the `AsyncObjects.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 `AsyncObjects.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 `AsyncObjects.xcodeproj` folder with `AsyncObjects.framework` nested inside.
100
+
- Select the `AsyncObjects.framework` and that's it!
101
+
102
+
> The `AsyncObjects.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 `AsyncObjects-{version}.xcframework.zip` where `{version}` is the version you want to use.
109
+
- Extract the XCFramework from the archive, and drag the `AsyncObjects.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 `AsyncObjects.xcframework` is automagically added in the embedded `Frameworks and Libraries` section, an in turn the linked framework in build phase. The dependencies aren't provided with the XCFramework and must be added separately.
113
+
114
+
## Usage
115
+
116
+
See the full [documentation](https://swiftylab.github.io/AsyncObjects/documentation/asyncobjects/) for API details and articles on sample scenarios.
117
+
118
+
## Contributing
119
+
120
+
If you wish to contribute a change, suggest any improvements,
| Linux | 5.6 | Swift Package Manager | Fully Tested |
20
+
| Windows | 5.6 | Swift Package Manager | Fully Tested |
21
+
22
+
## Installation
23
+
24
+
### CocoaPods
25
+
26
+
[CocoaPods](https://cocoapods.org) is a dependency manager for Cocoa projects. For usage and installation instructions, visit their website. To integrate `AsyncObjects` into your Xcode project using CocoaPods, specify it in your `Podfile`:
27
+
28
+
```ruby
29
+
pod 'AsyncObjects'
30
+
```
31
+
32
+
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:
33
+
34
+
```ruby
35
+
pod 'AsyncObjects', :http => 'https://github.com/SwiftyLab/AsyncObjects/releases/download/v{version}/AsyncObjects-{version}.xcframework.zip'
36
+
```
37
+
38
+
### Carthage
39
+
40
+
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. To integrate `AsyncObjects` into your Xcode project using Carthage, specify it in your `Cartfile`:
41
+
42
+
```ogdl
43
+
github "SwiftyLab/AsyncObjects"
44
+
```
45
+
46
+
### Swift Package Manager
47
+
48
+
The [Swift Package Manager](https://swift.org/package-manager/) is a tool for automating the distribution of Swift code and is integrated into the `swift` compiler.
49
+
50
+
Once you have your Swift package set up, adding `AsyncObjects` 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, but in this case dependencies must be added separately:
If you prefer not to use any of the aforementioned dependency managers, you can integrate `AsyncObjects` into your project manually.
65
+
66
+
#### Git Submodule
67
+
68
+
- 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:
69
+
70
+
```bash
71
+
$ git init
72
+
```
73
+
74
+
- Add `AsyncObjects` as a git [submodule](https://git-scm.com/docs/git-submodule) by running the following command:
- Open the new `AsyncObjects` folder, and drag the `AsyncObjects.xcodeproj` into the Project Navigator of your application's Xcode project or existing workspace.
81
+
82
+
> 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.
83
+
84
+
- Select the `AsyncObjects.xcodeproj` in the Project Navigator and verify the deployment target satisfies that of your application target (should be less or equal).
85
+
- 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.
86
+
- In the tab bar at the top of that window, open the "General" panel.
87
+
- Click on the `+` button under the `Frameworks and Libraries` section.
88
+
- You will see `AsyncObjects.xcodeproj` folder with `AsyncObjects.framework` nested inside.
89
+
- Select the `AsyncObjects.framework` and that's it!
90
+
91
+
> The `AsyncObjects.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.
92
+
93
+
#### XCFramework
94
+
95
+
You can also directly download the pre-built artifact from the GitHub releases page:
96
+
97
+
- Download the artifact from the GitHub releases page of the format `AsyncObjects-{version}.xcframework.zip` where `{version}` is the version you want to use.
98
+
- Extract the XCFramework from the archive, and drag the `AsyncObjects.xcframework` into the Project Navigator of your application's target folder in your Xcode project.
99
+
- Select `Copy items if needed` and that's it!
100
+
101
+
> The `AsyncObjects.xcframework` is automagically added in the embedded `Frameworks and Libraries` section, an in turn the linked framework in build phase. The dependencies aren't provided with the XCFramework and must be added separately.
0 commit comments