golem15/summercms
4
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/festival/README.md
View File

@@ -4,6 +4,8 @@ Typed, synchronous event bus with listener priorities, payload collection and st
`import "git.golem15.com/golem15/summercms/modules/festival"`
**Name:** A summer festival announces events and the crowd reacts; it is the event bus.
## Overview
`festival` is the SummerCMS counterpart of WinterCMS's `Event::listen` and `Event::fire`, the mechanism plugins use to extend each other without direct calls. Events are routed by their Go type rather than by a string name, so a listener registered for `*PostPublished` receives exactly that type, and a payload mismatch is a compile error. Each application owns one bus: [backpack](../backpack/README.md) creates it in `backpack.New` and exposes it as `backpack.App.Events`, and plugins register listeners from their Boot step.