From c5b6f1d1724412e2b70d6e56676fe20989ef0b80 Mon Sep 17 00:00:00 2001 From: Your Name Date: Sat, 20 Dec 2025 15:41:03 -0600 Subject: [PATCH] Add icon and expand README --- README.md | 56 +++++++++++++++++++++++++++++------ assets/groqd-chatstar-512.svg | 12 ++++++++ 2 files changed, 59 insertions(+), 9 deletions(-) create mode 100644 assets/groqd-chatstar-512.svg diff --git a/README.md b/README.md index 3fa7580..cce166c 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,57 @@ -# groqd +

+ groqd +

-Home Assistant custom integration for Groq Cloud with full, configurable LLM options. +

groqd

+ +

+ A Home Assistant custom integration for Groq Cloud with memory, web search, and link ingestion. +

+ +--- ## Features -- Multiple instances (different models, personalities, settings) -- Tool calling with Home Assistant LLM API integration -- Configurable prompts, context limits, and generation parameters -- Options flow for post-setup edits +- Multiple instances (different models, personalities, and settings) +- Persistent memory (device/user/global scopes) +- Tool calling via Home Assistant LLM API +- Optional web search via SearxNG +- Auto-fetch and ingest URLs from user messages +- Rich generation controls (temperature, top_p, penalties, max tokens, response format) ## Install (HACS) -1. Add this repository as a custom repository in HACS (type: Integration). +1. Add this repo as a **Custom Repository** in HACS (type: Integration): + `https://github.com/sudoxreboot/groqd` 2. Install `groqd`. 3. Restart Home Assistant. 4. Add the integration from **Settings → Devices & Services**. +## Quick Start +- Create a new groqd entry. +- Set your Groq API key. +- Pick a model (default: `meta-llama/llama-4-maverick-17b-128e-instruct`). +- Set a personality prompt if you want tone/style changes. + +## Options +Open **groqd → Options** to configure: +- Memory scope: `device`, `user`, `global`, or `conversation` +- Context window size +- Max tokens, temperature, top_p, penalties +- Response format (`text` / `json_object`) +- SearxNG (enable + URL + language + safe search) +- Auto-fetch URLs in user messages +- Time format (12h / 24h) + +## Recommended Prompt Additions +To make tone warmer and lyrical: + +""" +Be warm, playful, and a bit lyrical. If the user quotes lyrics, continue one line then respond empathetically. +""" + ## Notes -- Bring your own Groq API key. -- TTS is provided by Home Assistant and other integrations. +- TTS/STT are handled by Home Assistant and other integrations. +- Web search is optional and only used if enabled. +- Auto-fetch pulls page text and injects it into the prompt for better grounding. + +## Support +Open issues or requests at: https://github.com/sudoxreboot/groqd/issues diff --git a/assets/groqd-chatstar-512.svg b/assets/groqd-chatstar-512.svg new file mode 100644 index 0000000..07d087e --- /dev/null +++ b/assets/groqd-chatstar-512.svg @@ -0,0 +1,12 @@ + + + + + + + + + + + +