Index: packages/quiver_iterables/README.md |
diff --git a/packages/quiver_iterables/README.md b/packages/quiver_iterables/README.md |
new file mode 100644 |
index 0000000000000000000000000000000000000000..d9c4dc466910c38d74d3a20af7455b09d90c2937 |
--- /dev/null |
+++ b/packages/quiver_iterables/README.md |
@@ -0,0 +1,25 @@ |
+Quiver Iterables |
+================ |
+ |
+A collection of utilities for generating and manipulating Dart Iterables. |
+ |
+[](https://travis-ci.org/QuiverDart/quiver_iterables) |
+[](https://coveralls.io/r/QuiverDart/quiver_iterables) |
+ |
+## Documentation |
+ |
+[API Docs](http://www.dartdocs.org/documentation/quiver_iterables/latest) |
+ |
+`concat`, `count`, `cycle`, `enumerate`, `merge`, `partition`, `range`, and |
+`zip` create, transform, or combine Iterables in different ways, similar to |
+Python's itertools. |
+ |
+`min`, `max`, and `extent` retrieve the minimum and maximum elements from an |
+iterable. |
+ |
+`GeneratingIterable` is an easy way to create lazy iterables that produce |
+elements by calling a function. A common use-case is to traverse properties in |
+an object graph, like the parent relationship in a tree. |
+ |
+`InfiniteIterable` is a base class for Iterables that throws on operations that |
+require a finite length. |