@liip/liipgpt 3.5.8 → 3.6.0

package/README.md

@@ -2,11 +2,34 @@
 
 This package provides the following:
 
-1. A web component for embedding the LiipGPT chat UI
-2. A web component for embedding the LiipGPT button as a link
-3. A client library for interacting with the LiipGPT API
+1. A web component for embedding the LiipGPT chat UI (`<liipgpt-chat>`)
+2. A web component for embedding the LiipGPT button as a link (`<liipgpt-button>`)
+3. A one-shot search summary web component (`<liipgpt-search-summary>`)
+4. A client library for interacting with the LiipGPT API
 
+## Embed
 
+```html
+<!-- Chat -->
+<script src="https://cdn.example.com/@liip/liipgpt/chat/liipgpt-chat.iife.js"></script>
+<liipgpt-chat api-url="https://your-api.example.com/org" lang="en"></liipgpt-chat>
 
+<!-- Button -->
+<script src="https://cdn.example.com/@liip/liipgpt/button/liipgpt-button.iife.js"></script>
+<liipgpt-button api-url="https://your-api.example.com/org" lang="en"></liipgpt-button>
+
+<!-- Search summary -->
+<script src="https://cdn.example.com/@liip/liipgpt/search-summary/liipgpt-search-summary.iife.js"></script>
+<h2 id="ai-overview">AI overview</h2>
+<liipgpt-search-summary
+    labelled-by="ai-overview"
+    question="What can you tell me about your services?"
+    api-url="https://your-api.example.com/org"
+    lang="en"
+    height="280"
+></liipgpt-search-summary>
+```
+
+> **Note:** The standalone `@liip/liipgpt-search-summary` package is superseded by `@liip/liipgpt/search-summary` from this package.
 
 For more information please refer to: [docs.liipgpt.ch](https://docs.liipgpt.ch)