generated from exteraGramPlugins/pluginBase
Publish plugin / publish (push) Successful in 4s
README now carries the icon, TL;DR, description and features; the technical sections live in docs/. tools/icon_png.py renders images/icon.svg to a square PNG (512x512 by default, --resolution N). plugin.json points at the plugin's own icon. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
45 lines
2.3 KiB
Markdown
45 lines
2.3 KiB
Markdown
<p align="center">
|
||
<img src="images/icon.svg" width="128" height="128" alt="Chat Summaries icon">
|
||
</p>
|
||
|
||
<h1 align="center">Chat Summaries</h1>
|
||
|
||
**TL;DR:** an [exteraGram](https://exteragram.app) plugin that summarizes the last N
|
||
messages of any chat, group, channel or topic with AI, right inside the chat.
|
||
|
||
## Description
|
||
|
||
Chat Summaries sends a chat's recent history to any OpenAI-compatible endpoint (OpenAI,
|
||
OpenRouter, a local Ollama, …) and streams the answer into a summary card placed after the
|
||
newest summarized message. Summaries are saved on the device and come back whenever the chat
|
||
is reopened.
|
||
|
||
## Features
|
||
|
||
- **Summarize any chat.** ⋮ → Plugins → Summarize, or hold the unread button to summarize
|
||
the unread messages. Pick how many messages (1–1000) and an offset to skip the newest ones.
|
||
- **Streaming summary card.** Reasoning and answer stream into a card in the chat, which
|
||
jumps to it once. The finished summary ends with an `#aisummaries` hashtag.
|
||
- **Any OpenAI-compatible endpoint.** Set the base URL, API key (optional, e.g. for local
|
||
Ollama) and model in the settings.
|
||
- **Custom prompts.** A default prompt, with per-chat overrides.
|
||
- **Anonymized transcript.** Senders are sent to the model as numbers, not names; attached
|
||
file names are included only if you enable it.
|
||
- **Saved locally.** Summaries are restored when the chat is reopened. Delete a card like any
|
||
message to forget it; the settings show how many are saved and how much space they take,
|
||
and offer *Clear all summaries*.
|
||
- **Clean failures.** If anything fails before the answer starts, you only get a bulletin
|
||
and the chat is left untouched.
|
||
|
||
Summaries exist only on this device, so Telegram's search, which runs on the server, does
|
||
not find them, not even by `#aisummaries`.
|
||
|
||
## Documentation
|
||
|
||
- [How Chat Summaries works](docs/how-it-works.md): the summarize flow step by step
|
||
- [Development](docs/development.md): getting started, repo layout, building and verifying, icon export
|
||
- [How exteraGram plugins work](docs/how-plugins-work.md): the plugin format and lifecycle
|
||
- [Device setup and ADB automation](docs/device-and-adb.md): deploy, watch, logs, debugger
|
||
- [Versioning and releases](docs/versioning-and-releases.md): git hooks, auto-bump, CI publishing
|
||
- [SDK notes](docs/sdk-notes.md): condensed exteraGram SDK API surface
|