Skip to content

Commit da2a965

Browse files
authored
Update README to reflect support for Linux.
1 parent a5595df commit da2a965

File tree

1 file changed

+3
-15
lines changed

1 file changed

+3
-15
lines changed

README.md

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Ftrading-point%2Freactiveswift-composable-architecture%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/trading-point/reactiveswift-composable-architecture)
55
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Ftrading-point%2Freactiveswift-composable-architecture%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/trading-point/reactiveswift-composable-architecture)
66

7-
[Point-Free's](https://github.com/pointfreeco) [The Composable Architecture](https://github.com/pointfreeco/swift-composable-architecture) uses Apple's Combine framework as the basis of its `Effect` type. Unfortunately, Combine is only available on iOS 13 and macOS 10.15 and above. In order to be able to use it with earlier versions of the OSes, this fork has adapted The Composable Architecture to use [Reactive Swift](https://github.com/ReactiveCocoa/ReactiveSwift) as the basis for the `Effect` type.
7+
[Point-Free's](https://github.com/pointfreeco) [The Composable Architecture](https://github.com/pointfreeco/swift-composable-architecture) uses Apple's Combine framework as the basis of its `Effect` type. Unfortunately, Combine is only available on iOS 13 and macOS 10.15 and above. In order to be able to use it with earlier versions of the OSes, this fork has adapted The Composable Architecture to use [Reactive Swift](https://github.com/ReactiveCocoa/ReactiveSwift) as the basis for the `Effect` type. Since release 0.8.1 this fork has also added Linux compatibility.
88

99
## Effect type implementations
1010
<details>
@@ -19,7 +19,7 @@ Using ReactiveSwift, which doesn't use Combine's type model, `Effect<Output, Fai
1919

2020
# The Composable Architecture
2121

22-
The Composable Architecture (TCA, for short) is a library for building applications in a consistent and understandable way, with composition, testing, and ergonomics in mind. It can be used in SwiftUI, UIKit, and more, and on any Apple platform (iOS, macOS, tvOS, and watchOS).
22+
The Composable Architecture (TCA, for short) is a library for building applications in a consistent and understandable way, with composition, testing, and ergonomics in mind. It can be used in SwiftUI, UIKit, and more, and on any Apple platform (iOS, macOS, tvOS, and watchOS), and also on Linux.
2323

2424
* [What is the Composable Architecture?](#what-is-the-composable-architecture)
2525
* [Learn more](#learn-more)
@@ -420,7 +420,7 @@ If you are interested in contributing a wrapper library for a framework that we
420420

421421
## Requirements
422422

423-
This fork of The Composable Architecture uses the ReactiveSwift framework, it currently requires minimum deployment targets of iOS 12, macOS 10.14, Mac Catalyst 14, tvOS 14, and watchOS 5, although it may be possible to support earlier versions too.
423+
This fork of The Composable Architecture uses the ReactiveSwift framework, it currently requires minimum deployment targets of iOS 12, macOS 10.14, Mac Catalyst 14, tvOS 14, and watchOS 5, although it may be possible to support earlier versions too. Since release 0.8.1, Linux is also supported.
424424

425425
## Installation
426426

@@ -432,18 +432,6 @@ You can add ComposableArchitecture to an Xcode project by adding it as a package
432432
- If you have a single application target that needs access to the library, then add **ComposableArchitecture** directly to your application.
433433
- If you want to use this library from multiple targets you must create a shared framework that depends on **ComposableArchitecture** and then depend on that framework in all of your targets. For an example of this, check out the [Tic-Tac-Toe](./Examples/TicTacToe) demo application, which splits lots of features into modules and consumes the static library in this fashion using the **TicTacToeCommon** framework.
434434

435-
### Using with older OS versions that don't support Combine and SwiftUI
436-
437-
This fork is compatible with ealier versions of iOS and macOS that don't support Combine or SwiftUI (eg iOS 11.x, 12.x and macOS 10.14.x). However, it still supports SwiftUI and maintains all the SwiftUI specific code from the original library. This also includes some references to Combine (mainly for `ObservableObject` support).
438-
439-
If you want to use this library in a target built for an OS that doesn't support SwiftUI or Combine, you will need to add the following linker options to force SwiftUI and Combine to be weakly linked, in order to avoid having a runtime crash when dyld attemps to resolve the linkage and cannot find the frameworks:
440-
441-
```
442-
OTHER_LDFLAGS = -weak_framework Combine -weak_framework SwiftUI
443-
```
444-
445-
In Xcode, add these options to the `Other Linker Flags` section of `Build Settings`.
446-
447435
## Documentation
448436

449437
The latest documentation for the Composable Architecture APIs is available [here](https://trading-point.github.io/reactiveswift-composable-architecture/).

0 commit comments

Comments
 (0)