Add LLM provenance disclaimer to README

This commit is contained in:
2026-11-18 16:48:08 +00:00
parent 2b32c1a7f2
commit 3ebb0f9737
+18
View File
@@ -1,5 +1,10 @@
# signal-cal-bot — iCalendar → Signal # signal-cal-bot — iCalendar → Signal
> **Disclaimer:** this code was generated by LLMs (several different models)
> and has not been audited by a human security professional. Review it before
> relying on it, especially before exposing the Signal API, and treat it as
> provided without warranty. See [Provenance](#provenance).
Polls an iCalendar feed and posts events to a Signal group, with the event's Polls an iCalendar feed and posts events to a Signal group, with the event's
poster image attached. Built for [MCR Commons](https://commonscalendar.uk) (The poster image attached. Built for [MCR Commons](https://commonscalendar.uk) (The
Events Calendar), but works with any feed that exposes `UID`, `SUMMARY`, Events Calendar), but works with any feed that exposes `UID`, `SUMMARY`,
@@ -184,6 +189,19 @@ and must be re-paired.
| Watchdog alert about an empty feed | The site returned an empty calendar; stored events are left untouched. | | Watchdog alert about an empty feed | The site returned an empty calendar; stored events are left untouched. |
| `404` from the feed | The Events Calendar export URL changed; test it in a browser first. | | `404` from the feed | The Events Calendar export URL changed; test it in a browser first. |
## Provenance
This project was written by LLM coding agents across several models, with
human direction on requirements, design and review. It is a working tool, not
an audited library:
- No security audit has been performed. The service holds a Signal account's
linked-device credentials and runs an HTTP API on localhost.
- The logic is covered by an offline test suite, but coverage is not exhaustive,
particularly around network failure modes.
- Treat the defaults, comments and claims here as best effort. Verify behaviour
against your own feed and Signal setup before relying on it in production.
## Limitations ## Limitations
- Signal has no bot API; this relies on `signal-cli` and an unofficial REST - Signal has no bot API; this relies on `signal-cli` and an unofficial REST