New to Springtale? Read these in order. Each builds on the last.
┌─────────────────────────────────────────────────────────┐
│ │
│ 1. README.md ─────────────> What is it? Who is it for?│
│ │ │
│ v │
│ 2. guide/architecture.md ─> How the pieces fit │
│ │ │
│ v │
│ 3. guide/security.md ────> How it protects you │
│ │ │
│ v │
│ 4. guide/connectors.md ──> What connectors are │
│ │ │
│ v │
│ 5. guide/rules.md ───────> How to automate things │
│ │ │
│ v │
│ 6. QUICKSTART.md ────────> Build it, run it, try it │
│ │ │
│ v │
│ 7. GLOSSARY.md ──────────> Look up anything unfamiliar│
│ │
└─────────────────────────────────────────────────────────┘
Fig. 1. Suggested reading order for newcomers.
| I want to... | Go to |
|---|---|
| Look up a CLI command | reference/cli.md |
| Look up an API endpoint | reference/api.md |
| See a specific connector's triggers/actions | reference/connectors/ |
| Check a config option | reference/configuration.md |
| Understand a technical term | GLOSSARY.md |
| Build a new connector | contributing/adding-a-connector.md |
| Understand why we chose X over Y | contributing/design-decisions.md |
| See what's shipped vs planned | ROADMAP.md |