diff --git a/packages/dataverse/README.md b/packages/dataverse/README.md index 0735646..fe6a24c 100644 --- a/packages/dataverse/README.md +++ b/packages/dataverse/README.md @@ -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. \ No newline at end of file diff --git a/packages/dataverse/docs/GET_STARTED.md b/packages/dataverse/docs/GET_STARTED.md deleted file mode 100644 index 1b6618d..0000000 --- a/packages/dataverse/docs/GET_STARTED.md +++ /dev/null @@ -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. \ No newline at end of file