Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Improve the documentation of dataverse #116

Merged
merged 20 commits into from Apr 6, 2022
Merged

Improve the documentation of dataverse #116

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
4b00f45
Add `packages/dataverse/docs/GET_STARTED.md`
fulopkovacs Apr 1, 2022
5052c07
Add map() and prism() to the GET_STARTED.md doc in dataverse
fulopkovacs Apr 4, 2022
3fbb56a
Add docs for `usePrism()`
fulopkovacs Apr 4, 2022
7200cf3
Extend the documentation of `usePrism()`
fulopkovacs Apr 4, 2022
6480541
Add info about `Atom`-s to `GET_STARTED.md`
fulopkovacs Apr 4, 2022
2e804ef
Update the docs of `usePrism()`
fulopkovacs Apr 5, 2022
20a26cb
Add more info to `GET_STARTED.md`
fulopkovacs Apr 5, 2022
bbdd55f
Update the info about `usePrism()` in `GET_STARTED.md`
fulopkovacs Apr 5, 2022
a41f09d
Fix the syntax highlighting in `GET_STARTED.md`
fulopkovacs Apr 5, 2022
2fdecb1
Add basic docs to `effect()`
fulopkovacs Apr 5, 2022
ab90193
Add info about the `prism.state` and `prism.effect()` hooks to `GET_S…
fulopkovacs Apr 6, 2022
6b445dc
Add more information about the arguments of `prism.effect()` to `GET_…
fulopkovacs Apr 6, 2022
7221735
Update the documentation of `prism.effect()`
fulopkovacs Apr 6, 2022
51500a6
Mention the other methods of `prism` in `GET_STARTED.md`
fulopkovacs Apr 6, 2022
79eb809
Add a new note to pointers in `GET_STARTED.md`
fulopkovacs Apr 6, 2022
b92f732
Include the h4-s in the TOC of `GET_STARTED.md`
fulopkovacs Apr 6, 2022
fcade30
Fix some errors in `GET_STARTED.md`
fulopkovacs Apr 6, 2022
2590f4f
Add some changes to `GET_STARTED.md`
fulopkovacs Apr 6, 2022
a71ce47
Add info about the `Ticker` class to `GET_STARTED.md`
fulopkovacs Apr 6, 2022
d4d2acd
Add the `Ticker`-section to the TOC in `GET_STARTED.md`
fulopkovacs Apr 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 2 additions & 3 deletions packages/dataverse/README.md
View file
Open in desktop
@@ -1,11 +1,10 @@
# @theatre/dataverse

Dataverse is the reactive dataflow library [Theatre.js](https://www.theatrejs.com) is built on. It is inspired by ideas in [functional reactive programming](https://en.wikipedia.org/wiki/Functional_reactive_programming) and it is optimised for interactivity and animation.
Dataverse is the reactive dataflow library [Theatre.js](https://www.theatrejs.com) is built on. It is inspired by ideas in [functional reactive programming](https://en.wikipedia.org/wiki/Functional_reactive_programming) and it is optimised for interactivity and animation. Check out the [Get started guide](./docs/GET_STARTED.md) for a more practical introduction.

Dataverse is currently an internal library. It is used within Theatre.js, but its API is not exposed through Theatre. This is so that we can iterate on the reactive internals while keeping the public API stable. We plan to eventually have an LTS release, but for now, expect a high release cadence and API churn in dataverse while the API in Theatre.js remains stable.

## Documentation

* API Docs: [docs.theatrejs.com/api/dataverse](https://docs.theatrejs.com/api/dataverse.html)
* Guide: TODO

* Get started guide: [GET_STARTED.md](./docs/GET_STARTED.md)