|
1 | | -# route.bible/skill.md |
| 1 | +--- |
| 2 | +name: route-bible |
| 3 | +description: "Reference Bible passages via app-agnostic links and QR codes." |
| 4 | +version: 1.0.0 |
| 5 | +author: Dylan Shade (dpshde) |
| 6 | +license: MIT |
| 7 | +platforms: [linux, macos, windows] |
| 8 | +metadata: |
| 9 | + hermes: |
| 10 | + tags: [Bible, Religion, Scripture, Routing, API] |
| 11 | +--- |
2 | 12 |
|
3 | | -## Overview |
4 | | -route.bible is a routing and deep-linking layer for Bible passages. This skill allows the agent to generate and resolve app-agnostic Bible links. |
| 13 | +# route.bible |
5 | 14 |
|
6 | | -## stable URL contract |
7 | | -- `https://route.bible/{reference}` (e.g., `https://route.bible/John.3.16`) |
8 | | -- Supported formats: OSIS identifiers, common abbreviations. |
| 15 | +Reference Bible passages and generate app-agnostic links or QR codes. route.bible acts as a universal router, allowing users to open scriptures in their preferred Bible application (YouVersion, BibleGateway, Logos, etc.). |
9 | 16 |
|
10 | | -## Local Parsing |
11 | | -Use `grab-bcv` for local parsing of references before routing. |
| 17 | +## Quick Reference |
12 | 18 |
|
13 | | -## Integration |
14 | | -To integrate, refer to the hosted documentation at `https://route.bible/docs`. |
| 19 | +| Action | Pattern | |
| 20 | +|--------|---------| |
| 21 | +| Generate link | `https://route.bible/GEN.1.1` | |
| 22 | +| Generate QR code | `https://route.bible/GEN.1.1?qr=true` | |
| 23 | + |
| 24 | +## Usage |
| 25 | + |
| 26 | +The routing layer follows a stable URL contract using standard book abbreviations and OSIS-style references. |
| 27 | + |
| 28 | +### Canonical Link Generation |
| 29 | + |
| 30 | +To generate a universal link for a passage, use the following URL pattern: |
| 31 | +`https://route.bible/<BOOK>.<CHAPTER>.<VERSE>` |
| 32 | + |
| 33 | +Examples: |
| 34 | +- `https://route.bible/GEN.1.1` |
| 35 | +- `https://route.bible/JHN.3.16` |
| 36 | + |
| 37 | +### QR Code Integration |
| 38 | + |
| 39 | +To generate a QR code pointing to a passage, append `?qr=true` to the canonical link. |
| 40 | +- `https://route.bible/ROM.12.1-2?qr=true` |
0 commit comments