Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
luoxiu committed Aug 7, 2019
1 parent 9996804 commit feb64a8
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,22 @@

CombineX is an open source implementation for Apple's [Combine](https://developer.apple.com/documentation/combine) specs. It allows you to use Combine's API right now, without the need for macOS 10.15 or iOS 13, without the need for the Apple platform.

#### Goal
## Goal

`CombineX` will try to provide:

1. ~100% identical behavior to the Apple Combine.
2. More `Combine` not provided but very useful extensions. You can find them [here] (https://github.com/CombineXCommunity).
1. ~100% consistent behavior with the Apple Combine.
2. More extensions `Combine` don't have but are very useful. You can find them [here] (https://github.com/CombineXCommunity).

## Status

Compatible with Combine beta 5.
Compatible with Combine beta 5.

A new beta version will be released every Monday.

## Notice

This library is still in the test stage, **Please do not use it in production!**
This library is still in beta testing, **Please do not use it in production!**

🐱

Expand All @@ -31,7 +33,7 @@ In your `Package.swift`:

```swift
pkg.dependencies.append(
.package(url: "https://github.com/luoxiu/CombineX", ._branchItem("master")
.package(url: "https://github.com/luoxiu/CombineX", ._branchItem("master"))
)
```

Expand Down
8 changes: 5 additions & 3 deletions README.zh_cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

CombineX 是 Apple's [Combine](https://developer.apple.com/documentation/combine) 的开源实现。它可以让你现在就用上 Combine 的 API,不需要 macOS 10.15 或者 iOS 13,不需要 Apple 平台。

#### 目标
## 目标

`CombineX` 会尽力提供:

Expand All @@ -17,9 +17,11 @@ CombineX 是 Apple's [Combine](https://developer.apple.com/documentation/combine

与 Combine beta 5 兼容。

每周一会发布一个新的 beta~

## 注意

本库仍在测试阶段,所以,**还不可以把它用在生产项目中!**
本库仍在 beta 测试,所以,**还不可以把它用在生产项目中!**

🐱

Expand All @@ -31,7 +33,7 @@ CombineX 是 Apple's [Combine](https://developer.apple.com/documentation/combine

```swift
dependencies.append(
.package(url: "https://github.com/luoxiu/CombineX", ._branchItem("master")
.package(url: "https://github.com/luoxiu/CombineX", ._branchItem("master"))
)
```

Expand Down

0 comments on commit feb64a8

Please sign in to comment.