yes

Author: AWeirdDev

README.md

@@ -1,19 +1,62 @@
-# eaterate
-Modern Python iterators. With a Rust-like syntax, hell nawh.
+# Eaterate
+
+[GitHub](https://github.com/AWeirdDev/eaterate) ● [Docs](https://aweirddev.github.io/eaterate)
+
+Eaterate *(eet-uh-rate)* is a toolkit of modern Python iterators. Or whatever the hell you wanna call this.
+
+**Key features**:
+
+- **Fully typed**. C'mon, type annotations are just essential these days.
+- **Quick protyping**. Just chain everything.
+- **Flexible**. Build your custom iterators.
 
 ```python
 from eaterate import eater
 
-eat = eater("hi!").chain("yes")
+eat = eater("hi!").enumerate()
 
-for c in eat:
-    print(c)
+for index, char in eat:
+    print(index, char)
 
 # Output:
-# h
-# i
-# !
-# y
-# e
-# s
+# 0 h
+# 1 i
+# 2 !
+```
+
+## Quick tour
+With `eaterate`, you can use iterators in the easiest way possible:
+
+```python
+eat = (
+    eater([1, 2])
+    .chain([4, 5])
+    .map(lambda i: i * 2)
+)
+
+# collects to a list
+print(eat.collect(list))
+
+# [2, 4, 8, 10]
 ```
+
+You can also add separators to your iterator like never before (kind of):
+
+```python
+eat = eater([1, 2, 3]).intersperse(500)
+for i in eat:
+    print(i)
+
+# Output:
+# 1
+# 500
+# 2
+# 500
+# 3
+```
+
+There are a lot more features to try out! Refer to the [Core API](./core.md) reference for more!
+
+## Architecture
+
+Instead of raising `StopIteration` (exception-like) when an iterator ends, `eaterate` uses value wrappers, specifically [`Option[T]`](./utilities.md#eaterate.Option).

eaterate/core.py

@@ -201,8 +201,8 @@ def next(self) -> Option[int]:
             `Option.none()` if the iteration should stop.
         """
         raise NotImplementedError(
-            "`Eaterator` should be implemented manually.\n"
-            "See https://aweirddev.github.io/eaterate/ for more."
+            "`next()` should be implemented.\n"
+            "See https://aweirddev.github.io/eaterate/custom for custom iterators."
         )
 
     def next_chunk(self, n: int, *, strict: bool = False) -> list[T]: