@inventreedb/ui 0.0.2 → 0.0.4

package/CHANGELOG.md

@@ -4,4 +4,12 @@ This file contains historical changelog information for the InvenTree UI compone
 
 ### 1.0.0 - April 2025
 
-...
+Published the first version of the UI components API. This allows external plugins to hook into the InvenTree user interface, and provides global access to the following objects:
+
+- `window.React`: The core `react` library running on the UI
+- `window.ReactDOM`: The `react-dom` library
+- `window.ReactDOMClient`: The `react-dom/client` library
+- `window.MantineCore`: The `@mantine/core` library
+- `window.MantineNotifications`: The `@mantine/notifications` library
+
+All of these components can be "externalized" in the plugin build step.

package/README.md

@@ -2,16 +2,27 @@
 
 User Interface (UI) elements for the [InvenTree](https://inventree.org) web interface.
 
-This package provides a public interface allowing plugins to hook into core UI functionality.
 
-### Installation
-
-...
+### Description
 
-### Versioning
+This package provides a public interface allowing plugins to hook into core UI functionality. In particular, it defines a set of interface types provided by the InvenTree user interface, to be used by a custom plugin to implement some custom UI feature.
 
-...
+This library is intended to be used for creating plugins - any other use is outside of its scope and is not supported.
 
 ### Plugin Creator
 
-...
+This library is intended to be used with the [InvenTree Plugin Creator](https://github.com/inventree/plugin-creator). Read the documentation for the plugin creation tool for more information.
+
+The plugin creation tool uses the types provided in this package at build time, but it is intended that most of the major packages are *externalized* - as these are provided as global objects by the core InvenTree UI code.
+
+### Installation
+
+This should be installed as a part of the plugin creator tool. If you need to install it manually, e.g. using `npm`:
+
+```
+npm i @inventreedb/ui
+```
+
+### Versioning
+
+Each change to the plugin API will be described in the [CHANGELOG file](./CHANGELOG.md).