variablelab/theatre
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add notes to dataverse's docs

Browse source
This commit is contained in:
Aria Minaei 2023-01-15 14:50:33 +01:00
parent 3c68ed26ad
commit 415938212a
2 changed files with 2 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
packages/dataverse/README.md
View file

@ -1,10 +1,9 @@
# @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. Check out the [Get started guide](./docs/GET_STARTED.md) for a more practical introduction.
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 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)
* Get started guide: [GET_STARTED.md](./docs/GET_STARTED.md)
> TODO: Write new docs. Enough has changed between 0.5 and 0.6, that the 0.5 docs are not useful anymore.

3
packages/dataverse/docs/GET_STARTED.md
View file

@ -1,3 +0,0 @@
# Into the dataverse - Get started with `@theatre/dataverse`
> TODO: Dataverse has changed quite a bit since this guide was written, so let's write a new one.