Skip to content

Commit 5fadf86

Browse files
committed
docs: update README files to reflect new domain-grouped script structure and subscription instructions
1 parent fed8eab commit 5fadf86

3 files changed

Lines changed: 18 additions & 15 deletions

File tree

README.ja.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,13 @@ https://cdn.jsdelivr.net/npm/@filteringdev/tinyshield@latest/dist/tinyShield.use
2727
2828
- ビルド出力のファイル構成:
2929
- 基本スクリプト: `https://cdn.jsdelivr.net/npm/@filteringdev/tinyshield@latest/dist/tinyShield.user.js`
30-
- ドメイングループ別スクリプト: `https://cdn.jsdelivr.net/npm/@filteringdev/tinyshield@latest/dist/grouped/tinyShield-<domain-group>.user.js`
30+
- ドメイングループ別スクリプト: `https://cdn.jsdelivr.net/npm/@filteringdev/tinyshield@latest/dist/grouped/<initial>/tinyShield-<domain-group>.user.js`
3131
- ドメイングループごとの購読ファイル選択手順:
3232
1. `https://cdn.jsdelivr.net/npm/@filteringdev/tinyshield@latest/dist/grouped/` を開きます。
33-
2. 利用しているサイトに対応する `tinyShield-<domain-group>.user.js` を1つ選びます。
34-
3. そのファイルを一度開き、メタデータ `@match` に対象ドメインが含まれていることを確認します。
35-
4. Safari のユーザースクリプト拡張には、そのファイルURLをそのまま購読URLとして登録します。
33+
2. 対象グループのファイル名先頭文字に対応する `<initial>/` サブディレクトリを開きます。
34+
3. 利用しているサイトに対応する `tinyShield-<domain-group>.user.js` を1つ選びます。
35+
4. そのファイルを一度開き、メタデータ `@match` に対象ドメインが含まれていることを確認します。
36+
5. Safari のユーザースクリプト拡張には、そのファイルURLをそのまま購読URLとして登録します。
3637

3738
このドメイングループ分割は、issue #38 の影響範囲を可能な限り最小化することを目的としています。
3839

@@ -111,7 +112,7 @@ https://cdn.jsdelivr.net/npm/@filteringdev/tinyshield@latest/dist/tinyShield.use
111112
* iOS 18+: `システム設定` => `アプリ` => `Safari` => `拡張機能`
112113
* iOS 17 とそれ以下: `システム設定` => `Safari` => `拡張機能`
113114
**Usercripts**を見つけて有効化後に`他のサイト`の権限を許可します。
114-
4. `https://cdn.jsdelivr.net/npm/@filteringdev/tinyshield@latest/dist/grouped/` をブラウザで開き、対象ドメインに対応するグループスクリプトURL (`tinyShield-<domain-group>.user.js`) を選択します。
115+
4. `https://cdn.jsdelivr.net/npm/@filteringdev/tinyshield@latest/dist/grouped/` をブラウザで開き、`<initial>/` サブディレクトリに移動してから、対象ドメインに対応するグループスクリプトURL (`tinyShield-<domain-group>.user.js`) を選択します。
115116
5. Safariのアドレスバーにある拡張機能アイコンを押して、Userscriptsを選択します。
116117
6. タップでインストールします。
117118
7. 開いたポップアップを下にスクロールでインストールボタンを押します。

README.ko.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,13 @@ https://cdn.jsdelivr.net/npm/@filteringdev/tinyshield@latest/dist/tinyShield.use
3030
3131
- 빌드 결과 파일 구조:
3232
- 기본 스크립트: `https://cdn.jsdelivr.net/npm/@filteringdev/tinyshield@latest/dist/tinyShield.user.js`
33-
- 도메인 그룹 스크립트: `https://cdn.jsdelivr.net/npm/@filteringdev/tinyshield@latest/dist/grouped/tinyShield-<domain-group>.user.js`
33+
- 도메인 그룹 스크립트: `https://cdn.jsdelivr.net/npm/@filteringdev/tinyshield@latest/dist/grouped/<initial>/tinyShield-<domain-group>.user.js`
3434
- 도메인 그룹별 구독 파일 선택 방법:
3535
1. `https://cdn.jsdelivr.net/npm/@filteringdev/tinyshield@latest/dist/grouped/`를 엽니다.
36-
2. 사용하는 웹 사이트에 맞는 `tinyShield-<domain-group>.user.js` 파일 하나를 선택합니다.
37-
3. 해당 파일을 한 번 열어 메타데이터 `@match`에 대상 도메인이 포함되어 있는지 확인합니다.
38-
4. Safari 유저스크립트 확장에 그 파일 URL을 그대로 구독 URL로 등록합니다.
36+
2. 대상 그룹 파일명 첫 글자와 같은 `<initial>/` 하위 디렉터리로 이동합니다.
37+
3. 사용하는 웹 사이트에 맞는 `tinyShield-<domain-group>.user.js` 파일 하나를 선택합니다.
38+
4. 해당 파일을 한 번 열어 메타데이터 `@match`에 대상 도메인이 포함되어 있는지 확인합니다.
39+
5. Safari 유저스크립트 확장에 그 파일 URL을 그대로 구독 URL로 등록합니다.
3940

4041
이 도메인 그룹 분리는 issue #38의 영향 범위를 가능한 한 최소화하기 위한 목적입니다.
4142

@@ -72,7 +73,7 @@ https://cdn.jsdelivr.net/npm/@filteringdev/tinyshield@latest/dist/tinyShield.use
7273
* iOS 18 이상: `시스템 설정` => `` => `Safari` => `확장 프로그램`
7374
* iOS 17 이하: `시스템 설정` => `Safari` => `확장 프로그램`
7475
**Userscripts**을 찾으시고 활성화하신 후 `기타 웹 사이트` 권한을 허용하십시오.
75-
3. Safari에서 `https://cdn.jsdelivr.net/npm/@filteringdev/tinyshield@latest/dist/grouped/`를 열고, 대상 도메인에 맞는 그룹 스크립트 URL(`tinyShield-<domain-group>.user.js`)을 선택하십시오.
76+
3. Safari에서 `https://cdn.jsdelivr.net/npm/@filteringdev/tinyshield@latest/dist/grouped/`를 열고 `<initial>/` 하위 디렉터리로 이동한 뒤, 대상 도메인에 맞는 그룹 스크립트 URL(`tinyShield-<domain-group>.user.js`)을 선택하십시오.
7677
4. Safari의 주소바에 있는 확장 아이콘을 클릭하시고 **Userscripts**을 선택하십시오.
7778
5. 설치하는 버튼을 누르십시오.
7879
6. 열린 팝업을 스크롤하신 후에 설치하는 버튼을 누르십시오.

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,13 @@ https://cdn.jsdelivr.net/npm/@filteringdev/tinyshield@latest/dist/tinyShield.use
3030
3131
- Build output structure:
3232
- Default script: `https://cdn.jsdelivr.net/npm/@filteringdev/tinyshield@latest/dist/tinyShield.user.js`
33-
- Domain-grouped scripts: `https://cdn.jsdelivr.net/npm/@filteringdev/tinyshield@latest/dist/grouped/tinyShield-<domain-group>.user.js`
33+
- Domain-grouped scripts: `https://cdn.jsdelivr.net/npm/@filteringdev/tinyshield@latest/dist/grouped/<initial>/tinyShield-<domain-group>.user.js`
3434
- How to choose the subscription file for your domain group:
3535
1. Open `https://cdn.jsdelivr.net/npm/@filteringdev/tinyshield@latest/dist/grouped/`.
36-
2. Select one `tinyShield-<domain-group>.user.js` file for the website you use.
37-
3. Open that file once and confirm its metadata `@match` includes your target domain.
38-
4. Subscribe to that exact grouped file URL in your Safari userscript extension.
36+
2. Open the `<initial>/` subdirectory that matches the first character of your target grouped file name.
37+
3. Select one `tinyShield-<domain-group>.user.js` file for the website you use.
38+
4. Open that file once and confirm its metadata `@match` includes your target domain.
39+
5. Subscribe to that exact grouped file URL in your Safari userscript extension.
3940

4041
This domain-group split is intended to reduce the impact scope of issue #38 as much as possible.
4142

@@ -114,7 +115,7 @@ This domain-group split is intended to reduce the impact scope of issue #38 as m
114115
* iOS 18+: `System settings` => `Apps` => `Safari` => `Extensions`
115116
* iOS 17 and older: `System settings` => `Safari` => `Extensions`
116117
Find **Usercripts**, enable it and allow `On other sites` permission
117-
3. Open `https://cdn.jsdelivr.net/npm/@filteringdev/tinyshield@latest/dist/grouped/` in browser and select the grouped userscript URL for your domain (`tinyShield-<domain-group>.user.js`)
118+
3. Open `https://cdn.jsdelivr.net/npm/@filteringdev/tinyshield@latest/dist/grouped/` in browser, move to the `<initial>/` subdirectory, and select your grouped userscript URL (`tinyShield-<domain-group>.user.js`)
118119
4. Press the extensions icon in the address bar of Safari and select Userscripts
119120
5. Tap to install
120121
5. In opened popup, scroll down and press Install button

0 commit comments

Comments
 (0)