From 39ee182ecca42ac948df2ba7693e7e4b75b5c3c0 Mon Sep 17 00:00:00 2001 From: Julien Broi Date: Fri, 28 Jun 2024 20:34:12 +0200 Subject: [PATCH] docs: improve README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 06fda3b..b59b927 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # ZArrow -`ZArrow` is a functional programming library built on top of the [`ZIO`](https://zio.dev) (ZIO: Zero-dependency, type-safe, asynchronous, concurrent) library in Scala. +`ZArrow` is a functional programming library built to be used with the [`ZIO`](https://zio.dev) ecosystem. The library implements the type `ZArrow[I, R, E, O]`. Each instance of `ZArrow` describes an effectful mapping from `I` to `O`. Specifically, it maps any `I` to a `ZIO[R, E, O]`, which is a computation that requires an `R` and either succeeds with an `O`, fails with an `E`, or dies.