Documentation¶
| folder | read it to |
|---|---|
| Getting started | install hookspool, run the demo, turn on your first bobbin, and check it works |
| Configuration | look up a config key, set coalescing windows, routes and tees, or add a destination |
| Bobbins | find the bobbin for a service, write a new one, customise one privately, or review one |
| Operations | run it on a host, keep it healthy, repair a stuck batch, upgrade, and find a command |
| Architecture | understand the design, see how it compares with other tools, and read the FAQ |
The README is the short version. CONTRIBUTING.md is for people changing hookspool, and the changelog says what changed.