@record-evolution/widget-markdown 1.0.2 → 1.0.3

package/README.md

@@ -2,34 +2,109 @@
 
 ![thumbnail](thumbnail.png)
 
-## Installation
+A Lit web component for rendering markdown with syntax highlighting and variable interpolation support.
+
+<br>
+
+# Usage
+
+## Installation & Import
 
 ```bash
-npm i widget-markdown
+npm i @record-evolution/widget-markdown
 ```
 
-## Usage
-
 ```html
 <script type="module">
-    import 'widget-markdown/widget-markdown.js'
+    import '@record-evolution/widget-markdown'
 </script>
 
-<widget-markdown></widget-markdown>
+<widget-markdown-1.0.2 inputData="default-data"></widget-markdown-1.0.2>
 ```
 
-## Expected data format
+## Expected Data Format
+
+The widget accepts an `inputData` object with the following structure:
+
+```json
+{
+    "markdown": "# Hello {{userName}}\n\nWelcome to the dashboard!",
+    "data": [
+        {
+            "label": "userName",
+            "value": "John Doe"
+        }
+    ]
+}
+```
 
-## Tooling configs
+### Properties
 
-For most of the tools, the configuration is in the `package.json` to reduce the amount of files in your project.
+- **markdown** (textarea): The markdown text to render. Supports variable interpolation using `{{variableName}}` syntax.
+- **data** (array): List of variables to replace in the markdown text.
+    - **label** (string): The variable name used in the markdown text (e.g., `userName` for `{{userName}}`).
+    - **value** (string): The value that will replace the variable placeholder.
 
-If you customize the configuration a lot, you can consider moving them to individual files.
+### Features
 
-## Local Demo with `web-dev-server`
+- **Markdown Rendering**: Full CommonMark and GFM (GitHub Flavored Markdown) support via `marked`.
+- **Syntax Highlighting**: Code blocks are automatically highlighted using `highlight.js` with support for:
+    - Shell/Bash
+    - Python
+    - JavaScript/TypeScript
+    - JSON
+    - CSS
+    - Plaintext
+- **Variable Interpolation**: Dynamic content replacement using `{{variableName}}` placeholders.
+- **Theme Support**: Respects platform theme colors for background and text.
+
+<br>
+
+## Development
+
+> Keep the widget tag name in sync with the version in `package.json`. Update the version in `demo/index.html` accordingly (e.g., `<widget-markdown-1.0.2>`).
+
+To develop the widget locally:
 
 ```bash
-npm start
+npm run start
 ```
 
-To run a local development server that serves the basic demo located in `demo/index.html`
+This starts a development server at `localhost:8000/demo/` serving `demo/index.html`.
+
+### Using Widget in Another Project
+
+Install the widget in your project:
+
+```bash
+npm i @record-evolution/widget-markdown
+```
+
+## Releasing a New Version
+
+1. Commit all changes
+2. Regenerate types from schema (if modified):
+    ```bash
+    npm run types
+    ```
+3. Release:
+    ```bash
+    npm run release
+    ```
+
+This automatically:
+
+- Builds the widget
+- Bumps the patch version
+- Creates a git tag
+- Pushes to GitHub
+
+GitHub Actions will then publish the release to npm.
+
+### Platform Registration
+
+After publishing, register the new version in IronFlock:
+
+```sql
+select swarm.f_update_widget_master('{"package_name": "widget-markdown", "version": "1.0.2"}'::jsonb);
+```