Skip to content

Commit 33dc888

Browse files
committed
Clarify README and add download instructions
1 parent 95a4e11 commit 33dc888

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# stream.lua
22

3-
This small, single-file library is an iterator-chaining library implementing common functional programming patterns such as `map`, `filter`, and `reduce`:
3+
This single-file library is an iterator-chaining library implementing common functional programming patterns such as lazily-computed iterators `map`, `filter`, and `reduce`, a `Stream` class providing iterator-chaining via a fluent interface, and a number of [function utilities](#utilities).
44

55
For example, instead of the traditional approach using a for-loop with an if-statement to aggregate transformed data:
66

@@ -47,6 +47,14 @@ This means, that all iterator functions can also be nested (similar to Python),
4747

4848
An added benefit of using the library is that performance seems to be better than the traditional for-loop approach, although this is not the focus or main benefit of this library and as such is not guaranteed.
4949

50+
## Getting started
51+
52+
To use the library, download the [stream.lua](stream.lua) file and include it in your project, then require it in your source code and you are all set up:
53+
54+
```lua
55+
local fn = require "stream"
56+
```
57+
5058
## Documentation
5159

5260
### Type syntax used and definitions

0 commit comments

Comments
 (0)