Add icon and expand README

This commit is contained in:
Your Name 2025-12-20 15:41:03 -06:00
parent 9aa02e07f1
commit c5b6f1d172
2 changed files with 59 additions and 9 deletions

View file

@ -1,19 +1,57 @@
# groqd
<p align="center">
<img src="assets/groqd-chatstar-512.svg" alt="groqd" width="180" />
</p>
Home Assistant custom integration for Groq Cloud with full, configurable LLM options.
<h1 align="center">groqd</h1>
<p align="center">
A Home Assistant custom integration for Groq Cloud with memory, web search, and link ingestion.
</p>
---
## 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

View file

@ -0,0 +1,12 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="512" height="512" fill="none" stroke="url(#groqdStroke)" stroke-width="1.6" stroke-linecap="round" stroke-linejoin="round" role="img" aria-label="groqd icon">
<defs>
<linearGradient id="groqdStroke" x1="0" y1="0" x2="1" y2="1">
<stop offset="0%" stop-color="#7FFFD4"/>
<stop offset="35%" stop-color="#A6F0FF"/>
<stop offset="65%" stop-color="#B89CFF"/>
<stop offset="100%" stop-color="#FF4FD8"/>
</linearGradient>
</defs>
<path d="M5 6h14a3 3 0 0 1 3 3v5a3 3 0 0 1-3 3h-7l-4 3v-3H5a3 3 0 0 1-3-3V9a3 3 0 0 1 3-3z"/>
<path d="M12 8.3l1.1 2.2 2.4.3-1.8 1.6.5 2.3-2.2-1.2-2.2 1.2.5-2.3-1.8-1.6 2.4-.3z"/>
</svg>

After

Width:  |  Height:  |  Size: 716 B