wagesj45/Sortana
1
0
Fork 0
Code Issues Pull requests Projects Releases 5 Packages Wiki Activity Actions

docs: update README and add changelog

Browse source
This commit is contained in:
Jordan Wages 2025-06-21 18:52:00 -05:00
commit 6b00e4d665
2 changed files with 19 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

14
CHANGELOG.md Normal file
View file

@ -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.

6
README.md
View file

@ -13,9 +13,12 @@ message meets a specified criterion.
`matches` and `doesn't match` operators. `matches` and `doesn't match` operators.
- **Configurable endpoint** – set the classification service URL on the options page. - **Configurable endpoint** – set the classification service URL on the options page.
- **Prompt templates** – choose between several model formats or provide your own custom template. - **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 - **Filter editor integration** – patches Thunderbird's filter editor to accept
text criteria for AI classification. 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. - **Packaging script** – `build-xpi.ps1` builds an XPI ready for installation.
## Architecture Overview ## Architecture Overview
@ -43,6 +46,7 @@ APIs:
| `experiment/api.js` | Bridges WebExtension code with privileged APIs.| | `experiment/api.js` | Bridges WebExtension code with privileged APIs.|
| `content/filterEditor.js` | Patches the filter editor interface. | | `content/filterEditor.js` | Patches the filter editor interface. |
| `options/options.html` and `options.js` | Endpoint configuration UI. | | `options/options.html` and `options.js` | Endpoint configuration UI. |
| `logger.js` and `modules/logger.jsm` | Colorized logging with optional debug mode. |
## Building ## Building