golem15/summercms
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add a name mnemonic to every module README and the root modules table

Browse Source
This commit is contained in:
Jakub Zych
2026-10-11 00:26:20 +02:00
parent 5e3c552aa1
commit ca1443e9c8
25 changed files with 74 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
modules/lighthouse/README.md
View File

@@ -6,6 +6,8 @@ Transport-neutral realtime: a publisher interface with pluggable drivers, subscr
`import _ "git.golem15.com/golem15/summercms/modules/lighthouse/centrifugo"`
**Name:** Beams a signal out to everyone watching; it broadcasts realtime messages to subscribers.
## Overview
lighthouse is the SummerCMS counterpart of the WinterCMS websockets plugin. The package itself knows no transport. It owns the interfaces application code writes against, and a driver package supplies the transport. A driver registers itself from its `init` function, the way `database/sql` drivers do, and the application picks one with `realtime.driver`.