Skip to content

Commit

Permalink
Note in README
Browse files Browse the repository at this point in the history
  • Loading branch information
lpil committed Nov 20, 2024
1 parent 0941d68 commit b56bb1a
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ Unfold values on-demand from a function.
[![Package Version](https://img.shields.io/hexpm/v/gleam_yielder)](https://hex.pm/packages/gleam_yielder)
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/gleam_yielder/)


You may want to use this library when you have a function that can generate a
sequence of values but the sequence is too large to fit into memory, or it would
be wasteful to do so. You could instead create a `Yielder` for it and only have
the section you are working on in memory, and halt evaluation when you have
consumed as much of the sequence as you need for your program.
```sh
gleam add gleam_yielder@1
```
Expand Down

0 comments on commit b56bb1a

Please sign in to comment.