Provide high level description for the 4 packages

This commit is contained in:
Andrew Prifer 2022-01-19 13:53:41 +01:00 committed by Aria
parent 599cc101c9
commit eff1f158bc
3 changed files with 16 additions and 2 deletions

View file

@ -1,3 +1,9 @@
/**
* React bindings for dataverse.
*
* @packageDocumentation
*/
import type {IDerivation} from '@theatre/dataverse' import type {IDerivation} from '@theatre/dataverse'
import {Box} from '@theatre/dataverse' import {Box} from '@theatre/dataverse'
import {prism, val} from '@theatre/dataverse' import {prism, val} from '@theatre/dataverse'

View file

@ -1,7 +1,9 @@
/** /**
* Theatre comes in two packages: `@theatre/core` (the library) and * The library providing the runtime functionality of Theatre.js.
* `@theatre/studio` (the editor). This package is the core library. *
* @packageDocumentation
*/ */
export * from './coreExports' export * from './coreExports'
export type { export type {
IProject, IProject,

View file

@ -1,3 +1,9 @@
/**
* The library providing the editor components of Theatre.js.
*
* @packageDocumentation
*/
import {setStudio} from '@theatre/studio/getStudio' import {setStudio} from '@theatre/studio/getStudio'
import {Studio} from '@theatre/studio/Studio' import {Studio} from '@theatre/studio/Studio'