zaibihassan commited on
Commit
0087d1d
Β·
verified Β·
1 Parent(s): f75102e

Update README.md with corrected slugs and CDN domains

Browse files
Files changed (1) hide show
  1. README.md +39 -39
README.md CHANGED
@@ -71,14 +71,14 @@ https://cdn.mualim.app
71
  ### Quick Examples
72
  ```bash
73
  # Audio β€” Mishari Rashid Al-Afasy, Surah Al-Fatihah
74
- curl https://cdn.mualim.app/mishari-rashid-al-afasy-murattal-hafs/001.opus
75
 
76
  # Timing β€” Same reciter, same surah (Protocol Buffer)
77
- curl https://cdn.mualim.app/mishari-rashid-al-afasy-murattal-hafs/001.pb
78
 
79
  # Range Request (for mobile seeking)
80
  curl -H "Range: bytes=0-1024" \
81
- https://cdn.mualim.app/mishari-rashid-al-afasy-murattal-hafs/001.opus
82
  # β†’ 206 Partial Content βœ…
83
  ```
84
 
@@ -97,7 +97,7 @@ If the CDN is unavailable, you can fetch directly from HuggingFace:
97
  https://huggingface.co/datasets/zaibihassan/Quranic-Recitation-Data/resolve/main/{Folder Name}/{Surah}/{File}
98
  ```
99
 
100
- > **Note:** Folder names on HuggingFace contain spaces and special characters (e.g., `Mishari Rashid Al Afasy (Murattal – Hafs)`). The CDN slug mapping handles this automatically.
101
 
102
  ---
103
 
@@ -111,7 +111,7 @@ Each surah folder contains two files:
111
 
112
  ```
113
  Quranic-Recitation-Data/
114
- β”œβ”€β”€ Abdul Basit Abdul Samad (Mujawwad – Hafs)/
115
  β”‚ β”œβ”€β”€ 001/
116
  β”‚ β”‚ β”œβ”€β”€ 001.opus (Full Surah Al-Fatihah audio)
117
  β”‚ β”‚ └── 001.pb (Word timestamps for all ayahs)
@@ -119,8 +119,8 @@ Quranic-Recitation-Data/
119
  β”‚ β”‚ β”œβ”€β”€ 002.opus
120
  β”‚ β”‚ └── 002.pb
121
  β”‚ └── ...
122
- β”œβ”€β”€ Mishari Rashid Al Afasy (Murattal – Hafs)/
123
- β”œβ”€β”€ Alijon Qari/
124
  └── ...
125
  ```
126
 
@@ -168,40 +168,40 @@ The CDN uses URL-friendly slugs that map to the actual folder names on HuggingFa
168
 
169
  | # | CDN Slug | Folder Name |
170
  |---|---|---|
171
- | 1 | `abdul-basit-abdul-samad-mujawwad-hafs` | Abdul Basit Abdul Samad (Mujawwad – Hafs) |
172
- | 2 | `abdul-basit-abdul-samad-murattal-hafs` | Abdul Basit Abdul Samad (Murattal – Hafs) |
173
- | 3 | `abdul-rahman-al-sudais-murattal-hafs` | Abdul Rahman Al Sudais (Murattal – Hafs) |
174
- | 4 | `abdullah-hamad-abu-sharida` | Abdullah Hamad Abu Sharida |
175
- | 5 | `abu-bakr-al-shatri-murattal-hafs` | Abu Bakr Al Shatri (Murattal – Hafs) |
176
- | 6 | `ahmed-ibn-ali-al-ajmy` | Ahmed ibn Ali Al Ajmy |
177
- | 7 | `alijon-qari` | Alijon Qari |
178
- | 8 | `alnufais` | Alnufais |
179
- | 9 | `alzain-mohammad-ahmad` | Alzain Mohammad Ahmad |
180
  | 10 | `ayman-suwaid-muallim` | Ayman Suwaid (Muallim) |
181
- | 11 | `badr-al-turki` | Badr Al Turki |
182
- | 12 | `bandar-baleela` | Bandar Baleela |
183
- | 13 | `fatih-seferagic` | Fatih Seferagic |
184
- | 14 | `hani-ar-rifai-murattal-hafs` | Hani Ar Rifai (Murattal – Hafs) |
185
- | 15 | `idris-abkar` | Idris Abkar |
186
- | 16 | `khalid-al-jalil-murattal-hafs` | Khalid Al Jalil (Murattal – Hafs) |
187
- | 17 | `khalifa-al-tunaiji-murattal-hafs` | Khalifa Al Tunaiji (Murattal – Hafs) |
188
- | 18 | `maher-al-muaiqly-murattal-hafs` | Maher Al Muaiqly (Murattal – Hafs) |
189
- | 19 | `mahmoud-khalil-al-husary-mujawwad-hafs` | Mahmoud Khalil Al Husary (Mujawwad – Hafs) |
190
- | 20 | `mahmoud-khalil-al-husary-mualim-hafs` | Mahmoud Khalil Al Husary (Mualim – Hafs) |
191
- | 21 | `mahmoud-khalil-al-husary-murattal-hafs` | Mahmoud Khalil Al Husary (Murattal – Hafs – Version 2) |
192
- | 22 | `mishari-rashid-al-afasy-murattal-hafs` | Mishari Rashid Al Afasy (Murattal – Hafs) |
193
- | 23 | `mohamed-al-tablawi-murattal-hafs` | Mohamed Al Tablawi (Murattal – Hafs) |
194
- | 24 | `muhammad-al-luhaidan` | Muhammad Al Luhaidan |
195
  | 25 | `muhammad-siddiq-al-minshawi-kids` | Muhammad Siddiq Al Minshawi (Kids) |
196
- | 26 | `muhammad-siddiq-al-minshawi-murattal-hafs` | Muhammad Siddiq Al Minshawi (Murattal – Hafs) |
197
- | 27 | `nabil-ar-rifai` | Nabil Ar Rifai |
198
- | 28 | `noreen-siddiq-duri-an-abu-amr` | Noreen Siddiq (Duri 'an Abu Amr) |
199
- | 29 | `raad-mohammad-al-kurdi` | Raad Mohammad Al Kurdi |
200
- | 30 | `saad-al-ghamdi-murattal-hafs` | Saad Al Ghamdi (Murattal – Hafs) |
201
- | 31 | `saud-al-shuraim-murattal-hafs` | Saud Al Shuraim (Murattal – Hafs) |
202
- | 32 | `surah-recitation-hady-toure` | Surah Recitation – Hady Toure |
203
- | 33 | `tawfeeq-bin-saeed-as-sawaaigh` | Tawfeeq bin Saeed As Sawaaigh |
204
- | 34 | `yasser-al-dosari-murattal-hafs` | Yasser Al Dosari (Murattal – Hafs) |
205
 
206
  ---
207
 
 
71
  ### Quick Examples
72
  ```bash
73
  # Audio β€” Mishari Rashid Al-Afasy, Surah Al-Fatihah
74
+ curl https://cdn.mualim.app/mishari-rashid-al-afasy-murattal/001.opus
75
 
76
  # Timing β€” Same reciter, same surah (Protocol Buffer)
77
+ curl https://cdn.mualim.app/mishari-rashid-al-afasy-murattal/001.pb
78
 
79
  # Range Request (for mobile seeking)
80
  curl -H "Range: bytes=0-1024" \
81
+ https://cdn.mualim.app/mishari-rashid-al-afasy-murattal/001.opus
82
  # β†’ 206 Partial Content βœ…
83
  ```
84
 
 
97
  https://huggingface.co/datasets/zaibihassan/Quranic-Recitation-Data/resolve/main/{Folder Name}/{Surah}/{File}
98
  ```
99
 
100
+ > **Note:** Folder names on HuggingFace contain spaces and special characters (e.g., `Mishari Rashid Al Afasy (Murattal)`). The CDN slug mapping handles this automatically.
101
 
102
  ---
103
 
 
111
 
112
  ```
113
  Quranic-Recitation-Data/
114
+ β”œβ”€β”€ Abdul Basit Abdul Samad (Mujawwad)/
115
  β”‚ β”œβ”€β”€ 001/
116
  β”‚ β”‚ β”œβ”€β”€ 001.opus (Full Surah Al-Fatihah audio)
117
  β”‚ β”‚ └── 001.pb (Word timestamps for all ayahs)
 
119
  β”‚ β”‚ β”œβ”€β”€ 002.opus
120
  β”‚ β”‚ └── 002.pb
121
  β”‚ └── ...
122
+ β”œβ”€β”€ Mishari Rashid Al Afasy (Murattal)/
123
+ β”œβ”€β”€ Alijon Qari (Murattal)/
124
  └── ...
125
  ```
126
 
 
168
 
169
  | # | CDN Slug | Folder Name |
170
  |---|---|---|
171
+ | 1 | `abdul-basit-abdul-samad-mujawwad` | Abdul Basit Abdul Samad (Mujawwad) |
172
+ | 2 | `abdul-basit-abdul-samad-murattal` | Abdul Basit Abdul Samad (Murattal) |
173
+ | 3 | `abdul-rahman-al-sudais-murattal` | Abdul Rahman Al Sudais (Murattal) |
174
+ | 4 | `abdullah-hamad-abu-sharida-murattal` | Abdullah Hamad Abu Sharida (Murattal) |
175
+ | 5 | `abu-bakr-al-shatri-murattal` | Abu Bakr Al Shatri (Murattal) |
176
+ | 6 | `ahmed-ibn-ali-al-ajmy-murattal` | Ahmed ibn Ali Al Ajmy (Murattal) |
177
+ | 7 | `alijon-qari-murattal` | Alijon Qari (Murattal) |
178
+ | 8 | `ahmad-alnufais-murattal` | Ahmad Alnufais (Murattal) |
179
+ | 9 | `alzain-mohammad-ahmad-murattal` | Alzain Mohammad Ahmad (Murattal) |
180
  | 10 | `ayman-suwaid-muallim` | Ayman Suwaid (Muallim) |
181
+ | 11 | `badr-al-turki-murattal` | Badr Al Turki (Murattal) |
182
+ | 12 | `bandar-baleela-murattal` | Bandar Baleela (Murattal) |
183
+ | 13 | `fatih-seferagic-murattal` | Fatih Seferagic (Murattal) |
184
+ | 14 | `hani-ar-rifai-murattal` | Hani Ar Rifai (Murattal) |
185
+ | 15 | `idris-abkar-murattal` | Idris Abkar (Murattal) |
186
+ | 16 | `khalid-al-jalil-murattal` | Khalid Al Jalil (Murattal) |
187
+ | 17 | `khalifa-al-tunaiji-murattal` | Khalifa Al Tunaiji (Murattal) |
188
+ | 18 | `maher-al-muaiqly-murattal` | Maher Al Muaiqly (Murattal) |
189
+ | 19 | `mahmoud-khalil-al-husary-mujawwad` | Mahmoud Khalil Al Husary (Mujawwad) |
190
+ | 20 | `mahmoud-khalil-al-husary-mualim` | Mahmoud Khalil Al Husary (Mualim) |
191
+ | 21 | `mahmoud-khalil-al-husary-murattal` | Mahmoud Khalil Al Husary (Murattal) |
192
+ | 22 | `mishari-rashid-al-afasy-murattal` | Mishari Rashid Al Afasy (Murattal) |
193
+ | 23 | `mohamed-al-tablawi-murattal` | Mohamed Al Tablawi (Murattal) |
194
+ | 24 | `muhammad-al-luhaidan-murattal` | Muhammad Al Luhaidan (Murattal) |
195
  | 25 | `muhammad-siddiq-al-minshawi-kids` | Muhammad Siddiq Al Minshawi (Kids) |
196
+ | 26 | `muhammad-siddiq-al-minshawi-murattal` | Muhammad Siddiq Al Minshawi (Murattal) |
197
+ | 27 | `nabil-ar-rifai-murattal` | Nabil Ar Rifai (Murattal) |
198
+ | 28 | `noreen-siddiq-duri-an-abu-amr` | Noreen Siddiq (Duri an Abu Amr) |
199
+ | 29 | `raad-mohammad-al-kurdi-murattal` | Raad Mohammad Al Kurdi (Murattal) |
200
+ | 30 | `saad-al-ghamdi-murattal` | Saad Al Ghamdi (Murattal) |
201
+ | 31 | `saud-al-shuraim-murattal` | Saud Al Shuraim (Murattal) |
202
+ | 32 | `hade-toure-murattal` | Hade Toure (Murattal) |
203
+ | 33 | `tawfeeq-bin-saeed-as-sawaaigh-murattal` | Tawfeeq bin Saeed As Sawaaigh (Murattal) |
204
+ | 34 | `yasser-al-dosari-murattal` | Yasser Al Dosari (Murattal) |
205
 
206
  ---
207