Skip to content

Commit 788e8da

Browse files
Working on updates to README
1 parent 526403a commit 788e8da

File tree

1 file changed

+60
-18
lines changed

1 file changed

+60
-18
lines changed

README.md

Lines changed: 60 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This project provides a standardized collection of the most important prayers fr
88

99
## Current Collection
1010

11-
**50 prayers currently available:**
11+
**56 prayers currently available:**
1212

1313
```
1414
prayers/
@@ -73,12 +73,17 @@ Prayers are organized using a flexible **multi-label classification system** tha
7373

7474
### **Primary Categories**
7575
Each prayer has one primary theological focus:
76-
- **`christological`** - Prayers focused on Jesus Christ (Our Father)
77-
- **`marian`** - Prayers to the Virgin Mary (Hail Mary, Angelus, Memorare, Hail Holy Queen)
78-
- **`liturgical`** - Formal liturgical prayers (Glory Be)
79-
- **`saints`** - Prayers for saint intercession (St. Michael Prayer)
80-
- **`penitential`** - Prayers of repentance (Act of Contrition)
76+
- **`penitential`** - Prayers of repentance and confession (Act of Contrition, Confiteor)
77+
- **`seasonal`** - Prayers for specific liturgical seasons (Advent Antiphons, Christmas Prayer)
78+
- **`marian`** - Prayers to the Virgin Mary (Hail Mary, Angelus, Memorare, Hail Holy Queen)
79+
- **`christological`** - Prayers focused on Jesus Christ (Our Father, Jesus Prayer)
8180
- **`creeds`** - Statements of faith (Apostles' Creed)
81+
- **`liturgical`** - Formal liturgical prayers (Glory Be, Te Deum)
82+
- **`devotional`** - Private devotional prayers (Divine Mercy Chaplet)
83+
- **`holy-spirit`** - Prayers to the Holy Spirit (Come Holy Spirit, Veni Creator Spiritus)
84+
- **`for-the-dead`** - Prayers for the deceased (Eternal Rest, Prayer for the Dead)
85+
- **`daily`** - Prayers for daily recitation (Morning Offering, Evening Prayer)
86+
- **`saints`** - Prayers for saint intercession (St. Michael Prayer, Litany of Loreto)
8287

8388
### **Labels**
8489
Prayers can have multiple labels for flexible classification:
@@ -90,6 +95,30 @@ Prayers can have multiple labels for flexible classification:
9095
- **`rosary`** - Prayers used in the Rosary
9196
- **`mass`** - Prayers used in the Mass
9297
- **`protection`** - Prayers for spiritual protection
98+
- **`marian`** - Related to Mary
99+
- **`christological`** - Related to Christ
100+
- **`saints`** - Related to saints
101+
- **`penitential`** - Related to repentance
102+
- **`liturgical`** - Formal liturgical use
103+
- **`creeds`** - Statements of faith
104+
- **`holy-spirit`** - Related to the Holy Spirit
105+
- **`for-the-dead`** - Prayers for the deceased
106+
- **`evening`** - Evening prayers
107+
- **`morning`** - Morning prayers
108+
- **`mercy`** - Mercy-focused prayers
109+
- **`chaplet`** - Chaplet prayers
110+
- **`angels`** - Angel-related prayers
111+
- **`seasonal`** - Seasonal prayers (Advent, Christmas, Lent, Easter)
112+
- **`meals`** - Prayers before/after meals
113+
- **`family`** - Family prayers
114+
- **`contemplative`** - Contemplative prayers
115+
- **`eastern`** - Eastern Catholic traditions
116+
- **`litany`** - Litany prayers
117+
- **`petition`** - Petition prayers
118+
- **`intercession`** - Intercessory prayers
119+
- **`peace`** - Peace prayers
120+
- **`franciscan`** - Franciscan spirituality
121+
- **`praise`** - Prayers of praise
93122

94123
### **Importance Levels**
95124
- **`essential`** - Core prayers of fundamental importance
@@ -116,7 +145,7 @@ Each prayer JSON file follows this standardized structure:
116145
"title": "Prayer Title",
117146
"primary_category": "main-theological-focus",
118147
"labels": ["classification", "labels", "array"],
119-
"importance": "liturgical-importance-level",
148+
"importance": "essential",
120149
"type": "prayer-type",
121150
"description": "Brief description of the prayer",
122151
"origin": "Historical origin or source",
@@ -187,18 +216,18 @@ Each prayer JSON file follows this standardized structure:
187216

188217
- **id**: Unique identifier for the prayer (kebab-case)
189218
- **title**: The common name of the prayer
190-
- **primary_category**: Main theological focus ("marian", "christological", "saints", "liturgical", "penitential", "creeds")
191-
- **labels**: Array of classification labels (["core", "essential", "daily", "rosary", etc.])
192-
- **importance**: Liturgical significance ("essential", "common", "devotional")
193-
- **type**: Specific prayer type (e.g., "devotional", "liturgical", "scriptural")
219+
- **primary_category**: Main theological focus (see Primary Categories above)
220+
- **labels**: Array of classification labels (cannot be empty, must include primary_category)
221+
- **importance**: Liturgical significance ("essential", "common")
222+
- **type**: Specific prayer type (e.g., "scriptural", "devotional", "liturgical", "prayer")
194223
- **description**: Brief explanation of the prayer's purpose
195224
- **origin**: Historical background or source
196225
- **origin_date**: Earliest known date or century of origin in ISO 8601 format. Use ranges for uncertain dates (e.g., "0030/0033", "1050/1150") or approximate dates with "~" prefix (e.g., "~0200", "~1200")
197226
- **usage**: Context in which the prayer is typically used
198227
- **feast_days**: Associated liturgical celebrations
199228
- **devotions**: Related devotional practices (e.g., "rosary", "divine-mercy")
200-
- **created_date**: Date the JSON file was created
201-
- **last_modified**: Date the JSON file was last updated
229+
- **created_date**: Date the JSON file was created (ISO 8601 format)
230+
- **last_modified**: Date the JSON file was last updated (ISO 8601 format)
202231

203232
## Translation Fields
204233

@@ -232,6 +261,7 @@ Each content part has these properties:
232261
- `"response"`: The reply part (traditionally said by the congregation/people)
233262
- `"both"`: Text said by everyone together
234263
- **optional** (optional): Whether this content part is optional (default: false)
264+
- **optional** (optional): Whether this content part is optional (default: false)
235265

236266
### Speaker Roles in Liturgical Dialogue
237267

@@ -296,7 +326,7 @@ const prayerCollection = require('@codexcommunion/prayer-collection');
296326

297327
// Get all prayers (flat array)
298328
const allPrayers = prayerCollection.getAllPrayers();
299-
console.log(allPrayers.length); // 9
329+
console.log(allPrayers.length); // 56
300330

301331
// Get all primary categories
302332
const categories = prayerCollection.getPrimaryCategories();
@@ -308,7 +338,7 @@ console.log(labels); // ['core', 'essential', 'marian', 'daily', 'rosary', ...]
308338

309339
// Get prayers by primary category
310340
const marianPrayers = prayerCollection.getPrayersByPrimaryCategory('marian');
311-
console.log(marianPrayers.length); // 4
341+
console.log(marianPrayers.length); // 10
312342

313343
// Get prayers by label (flexible multi-classification)
314344
const corePrayers = prayerCollection.getPrayersByLabel('core');
@@ -523,12 +553,12 @@ interface PrayerMetadata {
523553

524554
#### `PrimaryCategory`
525555
```typescript
526-
type PrimaryCategory = 'christological' | 'marian' | 'liturgical' | 'saints' | 'penitential' | 'creeds';
556+
type PrimaryCategory = 'marian' | 'christological' | 'saints' | 'penitential' | 'liturgical' | 'devotional' | 'creeds' | 'holy-spirit' | 'for-the-dead' | 'daily' | 'seasonal';
527557
```
528558

529559
#### `Label`
530560
```typescript
531-
type Label = 'core' | 'essential' | 'common' | 'devotional' | 'daily' | 'rosary' | 'marian' | 'christological' | 'saints' | 'penitential' | 'liturgical' | 'creeds' | 'protection' | 'mass' | 'confession';
561+
type Label = 'core' | 'essential' | 'common' | 'devotional' | 'daily' | 'rosary' | 'marian' | 'christological' | 'saints' | 'penitential' | 'liturgical' | 'creeds' | 'holy-spirit' | 'for-the-dead' | 'protection' | 'mass' | 'evening' | 'morning' | 'mercy' | 'chaplet' | 'angels' | 'seasonal' | 'advent' | 'christmas' | 'easter' | 'lent' | 'meals' | 'family' | 'contemplative' | 'eastern' | 'litany' | 'petition' | 'passion' | 'intercession' | 'peace' | 'franciscan' | 'anthony' | 'joseph' | 'jude' | 'patrick' | 'rita' | 'therese' | 'praise' | 'biblical' | 'eucharistic' | 'ancient' | 'virtues' | 'confession' | 'brief' | 'fatima';
532562
```
533563

534564
#### `ImportanceLevel`
@@ -540,11 +570,23 @@ type ImportanceLevel = 'essential' | 'common' | 'devotional';
540570
```typescript
541571
interface PrayerTranslation {
542572
language: string;
543-
text: string;
573+
text?: string; // For simple prayers without references
574+
content?: ContentPart[]; // For prayers that reference other prayers
544575
notes?: string;
545576
}
546577
```
547578

579+
#### `ContentPart`
580+
```typescript
581+
interface ContentPart {
582+
type: 'instructions' | 'text' | 'prayer-reference';
583+
value: string; // For 'text'/'instructions': the text content; For 'prayer-reference': the prayer ID to reference
584+
count?: number; // Number of times to repeat this content part (default: 1)
585+
speaker?: 'versicle' | 'response' | 'both'; // Optional liturgical speaker role for dialogue prayers
586+
optional?: boolean; // Whether this content part is optional (default: false)
587+
}
588+
```
589+
548590
## Implementation Details
549591

550592
### Universal Compatibility Architecture

0 commit comments

Comments
 (0)