diff --git a/README.md b/README.md index 85ad4c0..c56f1d1 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,32 @@ -# Webdraw Library Widgets +# Webdraw Library prompts -The **Webdraw Library** allows developers to create and manage custom widgets by defining them in standalone HTML files. This guide provides instructions and best practices for adding widgets to the library. +The **Webdraw Library** allows developers to create and manage custom prompts by defining them in standalone HTML files. This guide provides instructions and best practices for adding prompts to the library. -## Adding a Widget +## Adding a prompt ### 1. Create an HTML File -Each widget is defined as a single HTML file. Name the file descriptively based on the widget's purpose (e.g., `my_custom_widget.html`). +Each prompt is defined as a single HTML file. Name the file descriptively based on the prompt's purpose (e.g., `my_custom_prompt.html`). ### 2. Define the Metadata -Add metadata tags to the `` section of your HTML file. These tags define the widget's properties and functionality. +Add metadata tags to the `` section of your HTML file. These tags define the prompt's properties and functionality. -#### Example Widget File +#### Example prompt File ```html - My Custom Widget + My Custom prompt - - + + - + - + @@ -40,9 +40,9 @@ Add metadata tags to the `` section of your HTML file. These tags define t | **Tag Name** | **Description** | |---------------------|--------------------------------------------------------------------------------------------| -| `description` | Short description of the widget's functionality. | -| `icon` | SVG icon that represents the widget. When embedded in the `content` attribute, all attributes inside the SVG must use single quotes (`'`). | -| `examples` | URL pointing to usage examples, documentation, or a demo of the widget. | +| `description` | Short description of the prompt's functionality. | +| `icon` | SVG icon that represents the prompt. When embedded in the `content` attribute, all attributes inside the SVG must use single quotes (`'`). | +| `examples` | URL pointing to usage examples, documentation, or a demo of the prompt. | | `metadata` | Set of custom instructions that will be added to the prompt to influence the result of the generated output. |