From d461edd598148585d746b56e39321403f4a153c9 Mon Sep 17 00:00:00 2001 From: Dor Shtaif Date: Sun, 17 Sep 2023 14:01:48 +0300 Subject: [PATCH] docs: move `README.md`'s secondary title line to be on top of the badges (#37) Move `README.md`'s secondary title line to be on top of the badges, so places like the NPM website would appropriately display that as a summary line next to the package name showcased - instead of the raw badges' HTML as seems to happen now, as they were appearing first in the file. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 28aa5fc..18b5995 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Iterified +> Convert any callback-based sequence of values into a full-fledged async iterable +

@@ -12,8 +14,6 @@

-> Convert any callback-based sequence of values into a full-fledged async iterable - `iterified` converts any callback-style sequence of zero or more values into an async iterable equivalent. This lets you take advantage of all the language features and semantics of async iterables, such as playing well with `async`-`await` and `for await...of` looping, streamlined error handling with `try-catch` and encapsulatation of resource clean up - for any kind of an asynchronous value stream. By being able to express any thing as an async iterable, it can further be supercharged using the growing number of available iterable utilities, such as [iter-tools](https://github.com/iter-tools/iter-tools), [IxJS](https://github.com/ReactiveX/IxJS) and many more.