Skip to content

Commit

Permalink
docs: move README.md's secondary title line to be on top of the bad…
Browse files Browse the repository at this point in the history
…ges (#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.
  • Loading branch information
shtaif authored Sep 17, 2023
1 parent 50ff024 commit d461edd
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Iterified

> Convert any callback-based sequence of values into a full-fledged async iterable
<p>
<a href="https://github.com/shtaif/iterified/actions/workflows/ci-tests.yaml">
<img alt="" src="https://github.com/shtaif/iterified/actions/workflows/ci-tests.yaml/badge.svg" />
Expand All @@ -12,8 +14,6 @@
</a>
<p>

> 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.
Expand Down

0 comments on commit d461edd

Please sign in to comment.