Documentation#
The README covers what this library does and how to use it. These pages cover how it is built and why.
| Page | What it answers |
|---|---|
| Architecture | How the modules fit together, and what happens on each request |
| Design decisions | Why the API looks the way it does, including the choices that could reasonably have gone the other way |
| Specification notes | Where WebSub and PubSubHubbub 0.4 differ, where they are silent, and what this library does about it |
| Conformance suite | What is verified, how to run it, and how to add a case |
| Writing an adapter | Supporting another router, and the traps a framework can set |
| Writing a storage backend | Implementing SubscriptionStore and proving it correct |
| Releasing | How the modules are versioned and tagged together |
API reference lives on pkg.go.dev. Every exported symbol has a doc comment, and behavior that follows from the spec links the section it comes from.