Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ddddxxx committed Jul 2, 2021
1 parent 5e30209 commit f9218de
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 12 deletions.
13 changes: 4 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,7 @@ Open-source implementation of Apple's [Combine](https://developer.apple.com/docu

## Get Started

CombineX contains 3 products: `CombineX`, `CXShim`, and `CXTest`. You can simply use `CombineX` and ignore the presence of system Combine.

But if you develop a library, it's encouraged to use `CXShim`, a virtual Combine interface, so your library is backward deployable **and** compatible with SwiftUI. See [Combine Compatible Package](https://github.com/cx-org/CombineX/wiki/Combine-Compatible-Package) for more information.

`CXTest` is a test infrastructure for Combine, built on `CXShim`. It provides useful test utilities like [TracingSubscriber](Sources/CXTest/TracingSubscriber.swift) and [VirtualTimeScheduler](Sources/CXTest/VirtualTimeScheduler.swift).
> If you develop a library, it's recommended to use [`CXShim`](https://github.com/cx-org/CXShim) so your library is compatible with SwiftUI.
### Requirements

Expand Down Expand Up @@ -55,14 +51,13 @@ pod 'CombineX/CXFoundation', "~> 0.3.2"
github "cx-org/CombineX" ~> 0.3.2
```

CXShim is only available with Swift Package Manager.

## Related Projects

These libraries bring additional functionality to Combine. They are all [Combine Compatible Package](https://github.com/cx-org/CombineX/wiki/Combine-Compatible-Package) and you're free to switch underlying Combine implementation between `CombineX` and Apple's `Combine`.

- [CXCocoa](https://github.com/cx-org/CXCocoa): provides `Combine` extensions to `Cocoa`, such as `KVO+Publisher`, `Method Interception`, `UIBinding`, `Delegate Proxy`, etc.
- [CXExtensions](https://github.com/cx-org/CXExtensions): provides a collection of useful extensions for `Combine`, such as `IgnoreError`, `DelayedAutoCancellable`, etc.
- [CXTest](https://github.com/cx-org/CXTest): test infrastructure for Combine. It provides useful test utilities like `TracingSubscriber` and `VirtualTimeScheduler`.
- [CXExtensions](https://github.com/cx-org/CXExtensions): provides a collection of useful extensions for Combine, such as `IgnoreError`, `DelayedAutoCancellable`, etc.
- [CXCocoa](https://github.com/cx-org/CXCocoa): provides Combine extensions to `Cocoa`, such as `KVO+Publisher`, `Method Interception`, `UIBinding`, `Delegate Proxy`, etc.

## License

Expand Down
7 changes: 4 additions & 3 deletions README_zh-Hans.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@

## 开始使用

> 如果你开发的是库,建议使用 [`CXShim`](https://github.com/cx-org/CXShim) 以使其兼容 SwiftUI。
### 要求

- Swift 5.0+ (Xcode 10.2+)
Expand Down Expand Up @@ -47,14 +49,13 @@ pod 'CombineX/CXFoundation', "~> 0.3.2"
github "cx-org/CombineX" ~> 0.3.2
```

CXShim 仅在 Swift Package Manager 下可用。

## 相关项目

以下这些库为 Combine 添加了额外功能。它们都是 [Combine 兼容库](https://github.com/cx-org/CombineX/wiki/Combine-Compatible-Package),你可以自由切换底层的 Combine 实现,以使用 CombineX 或是 Apple 提供的 Combine。

- [CXCocoa](https://github.com/cx-org/CXCocoa):提供 `Cocoa``Combine` 扩展。例如 `KVO+Publisher``Method Interception``UIBinding``Delegate Proxy` 等。
- [CXTest](https://github.com/cx-org/CXTest): 针对 Combine 的单元测试工具,例如 `TracingSubscriber``VirtualTimeScheduler` 等。
- [CXExtensions](https://github.com/cx-org/CXExtensions):提供一系列有用的 Combine 扩展,例如:`IgnoreError``DelayedAutoCancellable` 等。
- [CXCocoa](https://github.com/cx-org/CXCocoa):提供 `Cocoa` 的 Combine 扩展。例如 `KVO+Publisher``Method Interception``UIBinding``Delegate Proxy` 等。

## 许可协议

Expand Down

0 comments on commit f9218de

Please sign in to comment.