From eff1f158bcd7839010b9f3c95e98296436c6669a Mon Sep 17 00:00:00 2001 From: Andrew Prifer Date: Wed, 19 Jan 2022 13:53:41 +0100 Subject: [PATCH] Provide high level description for the 4 packages --- packages/react/src/index.ts | 6 ++++++ theatre/core/src/index.ts | 6 ++++-- theatre/studio/src/index.ts | 6 ++++++ 3 files changed, 16 insertions(+), 2 deletions(-) diff --git a/packages/react/src/index.ts b/packages/react/src/index.ts index c735e52..85e9673 100644 --- a/packages/react/src/index.ts +++ b/packages/react/src/index.ts @@ -1,3 +1,9 @@ +/** + * React bindings for dataverse. + * + * @packageDocumentation + */ + import type {IDerivation} from '@theatre/dataverse' import {Box} from '@theatre/dataverse' import {prism, val} from '@theatre/dataverse' diff --git a/theatre/core/src/index.ts b/theatre/core/src/index.ts index 4cedf4b..6094b05 100644 --- a/theatre/core/src/index.ts +++ b/theatre/core/src/index.ts @@ -1,7 +1,9 @@ /** - * Theatre comes in two packages: `@theatre/core` (the library) and - * `@theatre/studio` (the editor). This package is the core library. + * The library providing the runtime functionality of Theatre.js. + * + * @packageDocumentation */ + export * from './coreExports' export type { IProject, diff --git a/theatre/studio/src/index.ts b/theatre/studio/src/index.ts index add8191..715f50c 100644 --- a/theatre/studio/src/index.ts +++ b/theatre/studio/src/index.ts @@ -1,3 +1,9 @@ +/** + * The library providing the editor components of Theatre.js. + * + * @packageDocumentation + */ + import {setStudio} from '@theatre/studio/getStudio' import {Studio} from '@theatre/studio/Studio'