Merge pull request #26 from sideeffect-io/release/0.5.0

project: bump CHANGELOG to 0.5.0

Author: twittemb

CHANGELOG.md

@@ -1,3 +1,20 @@
+**v0.5.0 - Carbon:**
+
+This version brings a lot of internal refactoring and breaking changes + some new operators.
+
+Now `swift-async-algorithms` has been anounced, this library can be seen as a companion for the Apple repo.
+For now there is an overlap between both libraries, but when `swift-async-algorithms` becomes stable the overlapping operators while be deprecated in `AsyncExtensions`.
+
+Nevertheless `AsyncExtensions` will continue to provide the operators that the community needs and are not provided by Apple.
+
+- `AsyncBufferedChannel`/`AsyncThrowingBufferedChannel`: is the equivalent to `AsyncChannel` from Apple. The difference is that back-pressure is handled with a stack and the send operation is not suspending.
+- Subjects: the `subject` suffix has been adopted to all the "hot" `AsyncSequence` with a shared output. A throwing counterpart has been added.
+- `zip` and `merge` are top level functions to match Apple repo.
+- `AsyncThrowingJustSequence`: an `AsyncSequence` that takes a throwing closure to compute the only element to emit.
+- `AsyncStream.pipe()`: creates and `AsyncStream` by escaping the `Continuation` and returning a tuple to manipulate the inputs and outputs of the stream.
+- `mapToResult()`: maps events (elements or failure) from an `AsyncSequence` to a `Result`. The resulting `AsyncSequence` cannot fail.
+- `AsyncLazySequence`: is a renaming to match Apple repo for creating an `AsyncSequence` from a `Sequence`.
+
 **v0.4.0 - Bore:**
 
 - AsyncStreams: new @Streamed property wrapper

README.md

@@ -28,6 +28,8 @@ Include `"AsyncExtensions"` as a dependency for your executable target:
 
 Finally, add `import AsyncExtensions` to your source code.
 
+## Features
+
 ### Channels
 * [AsyncBufferedChannel](./Sources/AsyncChannels/AsyncBufferedChannel.swift): Buffered communication channel between tasks. The elements are not shared and will be spread across consumers (same as 
 AsyncStream)