Skip to content

Commit a67cbfb

Browse files
committed
Add README.md
1 parent 7158236 commit a67cbfb

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# FastForward\Iterators
2+
3+
[![PHP Version](https://img.shields.io/badge/php-7.4%20%7C%208.0%2B-blue.svg)](https://www.php.net/)
4+
[![License](https://img.shields.io/github/license/php-fast-forward/iterators)](https://opensource.org/licenses/MIT)
5+
6+
A robust and optimized library for advanced PHP Iterators.
7+
Enhance your PHP applications with high-performance iterators, supporting lookahead, peeking, filtering, grouping, and more.
8+
9+
## ✨ Features
10+
11+
- 🔁 Advanced and composable iterator types
12+
- 👀 Lookahead and peeking support
13+
- 🧼 Filtering and mapping
14+
- 🧩 Grouping, chunking, and flattening
15+
- 🧪 Fully tested, mutation safe, and statically analyzed
16+
17+
## 📦 Installation
18+
19+
Install via Composer:
20+
21+
```bash
22+
composer require fast-forward/iterators
23+
```
24+
25+
## 🛠 Usage
26+
27+
This package provides various iterator utilities under the `FastForward\Iterator` namespace.
28+
29+
Check out the [`examples/`](https://github.com/php-fast-forward/iterators/tree/main/examples) directory for hands-on usage of each iterator.
30+
31+
## 🧑‍💻 Author
32+
33+
**Felipe Sayão Lobato Abreu**
34+
35+
36+
## 📄 License
37+
38+
This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)