From 6b00e4d6658834b71892c35abb6df6e5e56d05ce Mon Sep 17 00:00:00 2001 From: Jordan Wages Date: Sat, 21 Jun 2025 18:52:00 -0500 Subject: [PATCH 1/2] docs: update README and add changelog --- CHANGELOG.md | 14 ++++++++++++++ README.md | 6 +++++- 2 files changed, 19 insertions(+), 1 deletion(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..b33c8aa --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,14 @@ +# Changelog + +## 1.2 - 2025-06-21 + +### Added +- Custom logging framework with colorized output. Debug mode can be toggled from the Options page. +- Advanced AI parameters (max tokens, temperature, etc.) are configurable in the Options page. +- Hash-based persistent caching to reuse classification results across Thunderbird restarts. +- Multiple icon sizes for better integration. +- Custom system prompt field for specifying additional instructions for the AI service. + +### Fixed +- Improved logger import to avoid security errors. +- Logging now reports only updated cache entries. diff --git a/README.md b/README.md index daee88a..9e9fd34 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,12 @@ message meets a specified criterion. `matches` and `doesn't match` operators. - **Configurable endpoint** – set the classification service URL on the options page. - **Prompt templates** – choose between several model formats or provide your own custom template. +- **Custom system prompts** – tailor the instructions sent to the model for more precise results. - **Filter editor integration** – patches Thunderbird's filter editor to accept text criteria for AI classification. -- **Result caching** – avoids duplicate requests for already-evaluated messages. +- **Persistent result caching** – classification results are saved to disk so messages aren't re-evaluated across restarts. +- **Advanced parameters** – tune generation settings like temperature, top‑p and more from the options page. +- **Debug logging** – optional colorized logs help troubleshoot interactions with the AI service. - **Packaging script** – `build-xpi.ps1` builds an XPI ready for installation. ## Architecture Overview @@ -43,6 +46,7 @@ APIs: | `experiment/api.js` | Bridges WebExtension code with privileged APIs.| | `content/filterEditor.js` | Patches the filter editor interface. | | `options/options.html` and `options.js` | Endpoint configuration UI. | +| `logger.js` and `modules/logger.jsm` | Colorized logging with optional debug mode. | ## Building From e0795ed394ef7f36936ef5d881f83b3f7651c1e2 Mon Sep 17 00:00:00 2001 From: Jordan Wages Date: Sat, 21 Jun 2025 18:54:01 -0500 Subject: [PATCH 2/2] Delete CHANGELOG.md --- CHANGELOG.md | 14 -------------- 1 file changed, 14 deletions(-) delete mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index b33c8aa..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,14 +0,0 @@ -# Changelog - -## 1.2 - 2025-06-21 - -### Added -- Custom logging framework with colorized output. Debug mode can be toggled from the Options page. -- Advanced AI parameters (max tokens, temperature, etc.) are configurable in the Options page. -- Hash-based persistent caching to reuse classification results across Thunderbird restarts. -- Multiple icon sizes for better integration. -- Custom system prompt field for specifying additional instructions for the AI service. - -### Fixed -- Improved logger import to avoid security errors. -- Logging now reports only updated cache entries.