Skip to content
This repository has been archived by the owner on Feb 24, 2021. It is now read-only.

Promote Arrow Fx Coroutines in library page #225

Merged
merged 2 commits into from
Aug 26, 2020
Merged

Promote Arrow Fx Coroutines in library page #225

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b372faf
Promote Arrow Fx Coroutines in library page, and reference to docs fo…
nomisRev Aug 26, 2020
46c497f
Merge branch 'master' into sv-update-fx-libraries-section
aballano Aug 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions arrow-docs/docs/quickstart/libraries/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ In this doc, we'll describe all the modules that form the core, alongside a list
* [arrow-core]({{ '/quickstart/libraries/#arrow-core' | relative_url }})
* [arrow-core-data]({{ '/quickstart/libraries/#arrow-core-data' | relative_url }})
* [arrow-optics]({{ '/quickstart/libraries/#arrow-optics' | relative_url }})
* [arrow-fx]({{ '/quickstart/libraries/#arrow-fx' | relative_url }})
* [arrow-fx-coroutines]({{ '/quickstart/libraries/#arrow-fx-coroutines' | relative_url }})
* [arrow-syntax]({{ '/quickstart/libraries/#arrow-syntax' | relative_url }})
* [arrow-fx-rx2 & arrow-fx-reactor]({{ '/quickstart/libraries/#arrow-fx-rx2&arrow-fx-reactor' | relative_url }})
* [arrow-mtl]({{ '/quickstart/libraries/#arrow-mtl' | relative_url }})
Expand Down Expand Up @@ -72,15 +72,16 @@ For all the new typeclasses, it also includes the extensions available for basic

Dependency: `arrow-core`

### arrow-fx
### arrow-fx-coroutines

```groovy
dependencies {
implementation "io.arrow-kt:arrow-fx:$arrow_version"
implementation "io.arrow-kt:arrow-fx-coroutines:$arrow_version"
}
```

The [fx library]({{ '/fx/' | relative_url }}) offers a powerful concurrency DSL with an emphasis on easy concurrency and parallelism with guarantees about concurrent and parallel resource safety. It can be used with Arrow Fx's IO or a set of typeclasses to abstract over concurrency frameworks like `RxJava`, `Reactor`, `Arrow's IO`, etc.
The [fx library]({{ '/fx/' | relative_url }}) is a Kotlin idiomatic functional effects stytem that offers a powerful set concurrency combinators and primitives with an emphasis on easy concurrency and parallelism with guarantees about concurrent and parallel resource safety and composition.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Concurrency is mentioned twice in the description. I'd go with operators instead of combinators too.

If offers a set of integrations for `KotlinX Coroutines`, `RxJava`, `Reactor`, etc. Check the [Arrow Fx documentation](({{ '/fx/' | relative_url }})) for more details.

Dependency: `arrow-core`

Expand Down