Document the PCUI module

playcanvas · Jan 19, 2024 · 95de015 · 95de015
1 parent f32dd08
commit 95de015
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -1,3 +1,14 @@
+/**
+ * PCUI is a front-end framework designed for creating user interfaces in web applications. It is
+ * particularly well-suited for building browser-based tools. It offers a comprehensive set of UI
+ * components like buttons, sliders, menus and data inputs.
+ * 
+ * PCUI is written in TypeScript. The API can be used from both TypeScript and JavaScript. A React
+ * wrapper is provided for easy integration with React applications.
+ *
+ * @module PCUI
+ */
+
 export * from './binding';
 export * from './components';