Skip to content

Commit 0e1b940

Browse files
committed
docs: update document
1 parent 5eafad5 commit 0e1b940

2 files changed

Lines changed: 115 additions & 3 deletions

File tree

README.ko.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## tinyShield
2+
3+
[![jsdelivr stat](https://data.jsdelivr.com/v1/package/npm/@list-kr/tinyshield/badge)](https://www.jsdelivr.com/package/npm/@list-kr/tinyshield)
4+
5+
tinyShield 유저스크립트는 애드쉴드 광고와 안티-애드블록을 차단합니다.
6+
7+
tinyShield 유저스크립트는 AdGuard와 애드블록 커뮤니티에 의해 관리되고 있습니다.
8+
9+
> [!IMPORTANT]
10+
> tinyShield 유저스크립트 유지보수자는 tinyShield 유저스크립트와 함께 아래 애드블록들 중 하나를 사용하실 것을 권장합니다:
11+
> - AdGuard
12+
> - uBlock Origin
13+
> - Brave 웹 브라우저의 Shield
14+
> - AdBlock Plus
15+
> - Ghostery
16+
>
17+
> 다른 애드블록 지원은 보장되지 않습니다.
18+
19+
### 빠른 시작
20+
아래 URL를 클릭하여 설치해주세요:
21+
22+
https://cdn.jsdelivr.net/npm/@list-kr/tinyshield@latest/dist/tinyShield.user.js

README.md

Lines changed: 93 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,94 @@
1-
# tinyShield
2-
tinyShield provides an alternative version of microShield userscript for speed-first users.
1+
## tinyShield
32

4-
Subscription URL: https://cdn.jsdelivr.net/npm/@list-kr/tinyshield@latest/dist/tinyShield.user.js
3+
[![jsdelivr stat](https://data.jsdelivr.com/v1/package/npm/@list-kr/tinyshield/badge)](https://www.jsdelivr.com/package/npm/@list-kr/tinyshield)
4+
5+
tinyShield blocks Ad-Shield advertisement and anti-adblock script.
6+
7+
tinyShield userscript is managed by the adblock community and AdGuard.
8+
9+
> [!IMPORTANT]
10+
> tinyShield userscript maintainer recommends using one of the following adblockers with tinyShield userscript:
11+
> - AdGuard
12+
> - uBlock Origin
13+
> - Brave web browser's Shield
14+
> - AdBlock Plus
15+
> - Ghostery
16+
>
17+
> Supporting other adblockers is not guaranteed.
18+
19+
### Quick Start
20+
Just click the following URL to detect this userscript.
21+
22+
https://cdn.jsdelivr.net/npm/@list-kr/tinyshield@latest/dist/tinyShield.user.js
23+
24+
### How to install
25+
- [Violentmonkey](https://addons.mozilla.org/en-US/firefox/addon/violentmonkey/) (Recommended if you cannot access AdGuard Premium) - Browser extension
26+
1. Open `Dashboard`.
27+
2. Click `New` button.
28+
3. Click `Install from URL` button.
29+
4. Input the following URL:
30+
```
31+
https://cdn.jsdelivr.net/npm/@list-kr/tinyshield@latest/dist/tinyShield.user.js
32+
```
33+
5. Click `OK` button.
34+
6. Confirm metadata of the userscript and click `Confirm installation`.
35+
7. Return to a tab opening the website protected by Ad-Shield and reload the tab by pressing <kbd>F5</kbd> or <kbd>Ctrl</kbd> + <kbd>R</kbd> or clicking the reload button.
36+
37+
- [Tampermonkey](https://addons.mozilla.org/en-US/firefox/addon/tampermonkey/) - Browser extension
38+
1. Open settings of Tampermonkey.
39+
2. Go to `Utilities` tab.
40+
3. Input the following URL into `Install from URL`:
41+
```
42+
https://cdn.jsdelivr.net/npm/@list-kr/tinyshield@latest/dist/tinyShield.user.js
43+
```
44+
4. Click `Install` button.
45+
5. Confirm metadata of the userscript and click `Install`.
46+
6. Return to a tab opening the website protected by Ad-Shield and reload the tab by pressing <kbd>F5</kbd> or <kbd>Ctrl</kbd> + <kbd>R</kbd> or clicking the reload button.
47+
48+
<details>
49+
<summary>Compatibility Table</summary>
50+
51+
Browser Extension | License | Status
52+
----------------- | ------ | -------
53+
[Tampermonkey](https://www.tampermonkey.net/) | Proprietary (Donationware) | ✔
54+
[Greasemonkey](https://www.greasespot.net/) | MIT | ✘
55+
[Violentmonkey](https://violentmonkey.github.io/) | MIT | ✔
56+
57+
</details>
58+
59+
- AdGuard for Windows
60+
1. Click `Settings`.
61+
2. Click `Extensions`.
62+
3. Click `Add extension`.
63+
4. Input the following URL:
64+
```
65+
https://cdn.jsdelivr.net/npm/@list-kr/tinyshield@latest/dist/tinyShield.user.js
66+
```
67+
5. Click `Install`.
68+
6. Confirm metadata of the userscript and click `Install`.
69+
7. Return to a tab opening the website protected by Ad-Shield and reload the tab by pressing <kbd>F5</kbd> or <kbd>Ctrl</kbd> + <kbd>R</kbd> or clicking the reload button.
70+
71+
72+
- AdGuard for Android
73+
1. Go to Settings -> Extension.
74+
2. Touch `New extension`.
75+
3. Input the following URL:
76+
```
77+
https://cdn.jsdelivr.net/npm/@list-kr/tinyshield@latest/dist/tinyShield.user.js
78+
```
79+
4. Touch `Next`.
80+
5. Confirm metadata of the userscript and touch `Add`.
81+
6. Return to a tab opening the website protected by Ad-Shield and reload the tab by touching the reload button.
82+
83+
84+
- AdGuard for iOS
85+
86+
Userscript is not supported currently on AdGuard for iOS.
87+
However, It will be supported in the future.[^1]
88+
89+
Of course, you can use an alternative temporally.[^2][^3]
90+
91+
92+
[^1]: https://github.com/AdguardTeam/AdguardForiOS/issues/1542
93+
[^2]: https://github.com/quoid/userscripts
94+
[^3]: https://apps.apple.com/us/app/userscripts/id1463298887

0 commit comments

Comments
 (0)