# [Flow][]
[![CI](https://github.com/tfausak/flow/workflows/CI/badge.svg)](https://github.com/tfausak/flow/actions/new)
[![Hackage](https://img.shields.io/hackage/v/flow)](https://hackage.haskell.org/package/flow)
[![Stackage](https://www.stackage.org/package/flow/badge/nightly?label=stackage)](https://www.stackage.org/package/flow)
Write more understandable Haskell.
Flow is a package that provides functions and operators for writing more
understandable Haskell. It is an alternative to some common idioms like
[`($)`][] for function application and [`(.)`][] for function composition.
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Cheat sheet](#cheat-sheet)
## Requirements
Flow requires a Haskell compiler. It is tested with recent versions of GHC, but
older or different compilers should be acceptable. For installation with Cabal,
Flow requires at least Cabal 1.8.
## Installation
To add Flow as a dependency to your package, add it to your Cabal file.
```
build-depends: flow ==1.0.*
```
## Usage
Flow is designed to be imported unqualified. It does not export anything that
conflicts with [the base package][].
``` hs
import Flow
```
### Cheat sheet
Flow | Base
--------------- | -------------
x |> f | `x & f`
f <| x | `f $ x`
`apply x f` | `f x`
`f .> g` | `f >>> g`
`g <. f` | `g . f`
`compose f g x` | `g (f x)`
`x !> f` | -
`f hlint -h hlint-flow.yaml