Skip to content

Commit 47019f0

Browse files
author
SMKRV
committed
docs(readme): Enhance quick setup guide readability
1 parent 64c2138 commit 47019f0

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ Lastly, the script can also aid in generating DNS FWD records, making it a compr
2020

2121
#### TLDR; ⚡ Quick Setup Guide
2222

23-
<div style="font-size:80%; border: 1px solid #ddd; padding: 10px; border-radius: 5px; background-color: #f9f9f9;">
24-
2523
> **Prerequisites**
2624
> - Unix-like system
2725
> - Install dependencies: `sudo apt-get install curl jq gawk grep parallel`
@@ -69,8 +67,6 @@ Lastly, the script can also aid in generating DNS FWD records, making it a compr
6967
>
7068
>**Tip**: Test thoroughly and monitor system resources!
7169
72-
</div>
73-
7470
---
7571
7672
### Table of Contents
@@ -177,14 +173,16 @@ This file contains a list of URLs from which the main domain lists are downloade
177173
178174
**Format:**
179175
```
180-
https://example.com/domain-list1.txt
176+
https://example.com/domain-list1.txt # This is a comment
181177
https://example.org/domain-list2.txt
178+
# This is a comment
182179
https://example.net/domain-list3.txt
183180
```
184181
185182
**Example Contents:**
186183
```
187184
https://raw.githubusercontent.com/hagezi/dns-blocklists/refs/heads/main/domains/native.tiktok.txt
185+
# This is a comment
188186
https://example.com/additional-domains.txt
189187
```
190188
@@ -198,14 +196,14 @@ This file contains a list of URLs from which the special domain lists are downlo
198196
**Format:**
199197
```
200198
https://example.com/special-domain-list1.txt
201-
https://example.org/special-domain-list2.txt
199+
https://example.org/special-domain-list2.txt # This is a comment
202200
https://example.net/special-domain-list3.txt
203201
```
204202
205203
**Example Contents:**
206204
```
207205
https://raw.githubusercontent.com/hagezi/dns-blocklists/refs/heads/main/domains/doh.txt
208-
https://example.com/additional-special-domains.txt
206+
https://example.com/additional-special-domains.txt # This is a comment
209207
```
210208
211209
#### `WHITELIST_FILE`
@@ -219,12 +217,13 @@ This file contains a list of URLs from which whitelist domain lists are download
219217
```
220218
https://example.com/domain-list1.txt
221219
https://example.org/domain-list2.txt
220+
# This is a comment
222221
https://example.net/domain-list3.txt
223222
```
224223
225224
**Example Contents:**
226225
```
227-
https://raw.githubusercontent.com/hagezi/dns-blocklists/refs/heads/main/domains/native.apple.txt
226+
https://raw.githubusercontent.com/hagezi/dns-blocklists/refs/heads/main/domains/native.apple.txt # This is a comment
228227
https://raw.githubusercontent.com/hagezi/dns-blocklists/refs/heads/main/domains/native.samsung.txt
229228
```
230229
@@ -234,7 +233,7 @@ https://raw.githubusercontent.com/hagezi/dns-blocklists/refs/heads/main/domains/
234233
- **`SOURCESSPECIAL_FILE`**: Contains URLs for downloading the special domain lists.
235234
- **`WHITELIST_FILE`**: Contains URLs for downloading domains that should be excluded from both the main and special lists.
236235
237-
**Each file should have one URL or domain per line, with no additional spaces or characters.**
236+
**Each file should have one URL or domain per line, with no additional spaces or characters. Inline comments can be added after the URL using `#`, and comments can also be placed before or after the line.**
238237
239238
### Detailed Description of Domain Processing in Downloaded Lists
240239

0 commit comments

Comments
 (0)