Skip to content

README.md edits #99

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 24 commits into from
Mar 12, 2025
Merged
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
a45c948
various `README.md` edits
shtaif Jan 28, 2025
9ab8865
more readme edits
shtaif Jan 28, 2025
2c0b40b
Merge branch 'master' into readme-edits
shtaif Jan 28, 2025
2def7f9
edit `README.md`
shtaif Jan 31, 2025
6e5ce35
fix StackBlitz link adjacent text
shtaif Feb 4, 2025
5401c1f
Merge branch 'master' of https://github.com/shtaif/react-async-iterat…
shtaif Feb 4, 2025
c0449fb
Merge branch 'master' of https://github.com/shtaif/react-async-iterat…
shtaif Feb 4, 2025
80e2eb6
Merge branch 'master' of https://github.com/shtaif/react-async-iterat…
shtaif Feb 17, 2025
304407a
various `README.md` edits
shtaif Feb 17, 2025
c0c4100
Merge branch 'master' of https://github.com/shtaif/react-async-iterat…
shtaif Feb 19, 2025
5286535
`README.md` edits
shtaif Feb 19, 2025
5e600b1
Merge branch 'master' of https://github.com/shtaif/react-async-iterat…
shtaif Feb 19, 2025
0fa16cb
`README.md` edits
shtaif Feb 19, 2025
f8d8bff
Merge branch 'master' of https://github.com/shtaif/react-async-iterat…
shtaif Feb 19, 2025
2a25169
`README.md` edits
shtaif Feb 19, 2025
bbe9d8c
`README.md` edits
shtaif Feb 19, 2025
6e4d293
`README.md` edits
shtaif Feb 19, 2025
439bdf6
Merge branch 'master' of https://github.com/shtaif/react-async-iterat…
shtaif Feb 20, 2025
9e42aa1
`README.md` edits
shtaif Feb 20, 2025
c204b45
Merge branch 'master' of https://github.com/shtaif/react-async-iterat…
shtaif Feb 20, 2025
3a30961
Merge branch 'master' of https://github.com/shtaif/react-async-iterat…
shtaif Feb 21, 2025
bde512a
Merge branch 'master' of https://github.com/shtaif/react-async-iterat…
shtaif Feb 21, 2025
06ad9f1
Merge branch 'master' of https://github.com/shtaif/react-async-iterat…
shtaif Mar 12, 2025
beeadc6
`README.md` edits
shtaif Mar 12, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

A React.js library that makes it __easy and satisfying__ to integrate and render JS async iterators across and throughout your app's components. Expanding from that, it enables you to describe and propagate states and various aspects of your app in actual async iterator form, tapping into the full benefits and flexibility of this JS construct.

To facilitate this, `react-async-iterators` offers a set of tools specifically tailored for the frontend and React while embracing composability with the upcoming standardization of [Async Iterator Helpers proposal](https://github.com/tc39/proposal-async-iterator-helpers) as well as utility libraries such as [iter-tools](https://github.com/iter-tools/iter-tools), [IxJS](https://github.com/ReactiveX/IxJS) and more. You may use this library as a one-off in your code; e.g got an async iterable from a third-party SDK and just need to consume it. You may also employ it throughout your entire app. That's up to you. The library just aims to be _"everything async iterators and React"_ and is fully tree-shakable.
To facilitate this, `react-async-iterators` offers a set of tools specifically tailored for the frontend and React while embracing composability with the upcoming standardization of [Async Iterator Helpers proposal](https://github.com/tc39/proposal-async-iterator-helpers) as well as utility libraries such as [iter-tools](https://github.com/iter-tools/iter-tools), [IxJS](https://github.com/ReactiveX/IxJS) and more. You may use this library as a one-off in your code; e.g. got an async iterable from a third-party SDK and just need to consume it. You may also employ it throughout your entire app. That's up to you. The library just aims to be _"everything async iterators and React"_ and is fully tree-shakable.

The goal behind this library is to promote a mental model where every piece of data in a JavaScript program can be expressed either in a plain and static form, or in a ___dynamic, self-evolving___ form - an async iterable. That by simply wrapping a value in an async iterator or iterable, it becomes a self-updating entity while remaining first-class data. From this, it follows naturally that interfaces should and could intuitively accommodate either kind as received input, and seamlessly adapt to any changes over time just as you'd expect.

Expand Down