Change format

jinyuzu99 · Nov 30, 2024 · 2f9ec17 · 2f9ec17
1 parent 70854ba
commit 2f9ec17
Show file tree

Hide file tree

Showing 44 changed files with 56 additions and 58 deletions.
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -1,12 +1,12 @@
 # These are supported funding model platforms
 
-github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
-patreon: sayo_melu # Replace with a single Patreon username
+github: [jinyuzu99] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: jinyuzu99 # Replace with a single Patreon username
 open_collective: # Replace with a single Open Collective username
 ko_fi: # Replace with a single Ko-fi username
 tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
 community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
 liberapay: # Replace with a single Liberapay username
 issuehunt: # Replace with a single IssueHunt username
 otechie: # Replace with a single Otechie username
-custom: 'afdian.net/@sayo-melu'# Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
diff --git a/document/contribute.md b/document/contribute.md
@@ -1,61 +1,59 @@
-# contribute
+# Contribute
 
-## feedback
+## Feedback
 
-if you want to:
+If you want to:
 
-- ask question
-- report bug
-- request feature
-- vote for feature request
+- Ask question
+- Report bugs
+- Request feature
+- Vote for feature request
 
-please create or check issue to make contribution.
+Please create or check issue to make contribution.
 
-## contribute to code
+## Contribute to Code
 
-if you want to contribute directly to the code base, please follow the step below.
+If you want to contribute directly to the code base, please follow the steps below.
 
-### get the source
+### 1. Environment
 
-```
-git clone https://github.com/sayomelu/nothingblock
-```
-
-### prerequisite
+- Git
+- Web browser
+- Ad Blocker
+  - uBlock Origin
+  - other...
+- Code editor
 
-- git
-- web browser
-- blocker
-  - ublock original
-  - adblock plus
-  - ...
-- code editor
+### 2. Get the Source
 
-### writing filter
+```
+git clone https://github.com/jinyuzu99/nothingblock
+```
 
-setup with **ublock original** + **visual studio code**, other are similar.
+### 3. Writing Filters
 
-1. open the website you want to block on your **web browser** with **ad blocker** enabled.
-2. **secondary click** on the website element you want to block, then choose **block element**.
-3. find the appropriate fliter in **cosmetic filters**, then choose **preview** to check your fliter.
-4. choose **create** to create a new filter.
-5. repeat step **2** ~ **4** until there is nothing to block.
-6. go to **ad blocker** -> **dashboard** -> **my filter**, then copy all the filter.
-7. create and open a new `[website name with lowercase and hyphen: sample-website].txt` file in `nothingblock/item/` with **code editor**.
-8. paste the text to `[website name with lowercase and hyphen: sample-website].txt`.
-9. edit the file in the format below:
+Setup with **uBlock Origin** + **Visual Studio Code**, others are similar.
 
+1. Open the website you want to block on your **web browser** with **uBlock Origin** enabled.
+2. **Secondary click** on the website element you want to block, then choose **Block Element**.
+3. Find the appropriate fliter in **Cosmetic Filters**, then choose **Preview** to check your fliter.
+4. Choose **Create** to create a new filter.
+5. Repeat step **2** - **4** until there is nothing to block.
+6. Go to **uBlock Origin** -> **Dashboard** -> **My Filter**, then copy all the filter.
+7. Create and open a new `[website name with lowercase and hyphen: sample-website].txt` file in `nothingblock/website/` with ****.
+8. Paste the text to `[website name with lowercase and hyphen: sample-website].txt`.
+9. Edit the file in the format below:
     ```adp
-    ! [website section 1]
+    ! [Website Section 1]
       [filter 1]
       [filter 2]
       ...
-    ! [website section 2]
+    ! [Website Section 2]
       [filter 3]
       [filter 4]
       ...
     ```
 
-### pull request
+### 4. Pull Request
 
-after writing your filter, you can pull request to nothingblock.
+After writing your filters, you can pull request to NothingBlock.
diff --git a/document/resource/nothongblock logo.psd → document/resource/nothongblock-logo.psd b/document/resource/nothongblock logo.psd → document/resource/nothongblock-logo.psd
diff --git a/filter.txt b/filter.txt
@@ -1,7 +1,7 @@
 [Adblock Plus 3.0]
-! Title: nothingblock filter
+! Title: NothingBlock filter
 ! Description: block unnecessary web element to have 'nothing more to take away'.
-! Homepage: https://github.com/dorjmi/nothingblock
+! Homepage: https://github.com/jinyuzu99/nothingblock
 ! Version: 2023.11.16.1315
 ! Expires: 7 days
 acfun.cn###appguideBox

diff --git a/generate.py b/generate.py
@@ -8,7 +8,7 @@
 
 head = """\
 [Adblock Plus 3.0]
-! Title: nothingblock filter
+! Title: NothingBlock filter
 ! Description: block unnecessary web element to have 'nothing more to take away'.
 ! Homepage: https://github.com/dorjmi/nothingblock
 ! Version: {version}

diff --git a/license.txt b/license.txt
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 sayo melu
+Copyright (c) 2021 Yuzu Jin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

diff --git a/readme.md b/readme.md
@@ -1,33 +1,33 @@
 <h1>
 	<sub>
-		<img src='asset/nothongblock-logo.png' alt='nothongblock logo' height='40' width='40'>
+		<img src='asset/nothongblock-logo.png' alt='NothongBlock Logo' height='40' width='40'>
 	</sub>
-	nothingblock
+	NothingBlock
 </h1>
 
-> you know you have achieved perfection in design, not when you have nothing more to add, but when you have nothing more to take away. -- antoine de saint exupery
+> You know you have achieved perfection in design, not when you have nothing more to add, but when you have nothing more to take away. - Antoine de Saint-Exupéry
 
-**nothingblock** block unnecessary web element to have 'nothing more to take away'.
+**NothingBlock** blocks unnecessary web elements to have 'Nothing more to take away'.
 
-![nothingblock sample](asset/nothingblock-sample.jpg)
+![NothingBlock Sample](asset/nothingblock-sample.jpg)
 
-## start
+## Start
 
-add the url below to your [blocker](https://github.com/topics/blocker) to use **all filter**. (or from [github](https://raw.githubusercontent.com/jinyuzu99/nothingblock/main/filter.txt))
+Add the URL below to your [blocker](https://github.com/topics/blocker) to use **All Filters**. (or from [GitHub](https://raw.githubusercontent.com/jinyuzu99/nothingblock/main/filter.txt))
 
 ```
 https://cdn.jsdelivr.net/gh/jinyuzu99/nothingblock/filter.txt
 ```
 
-to add **specific filter**, copy the filter below and paste to your ad blocker.
+To add **Specific Filter**, copy the filter below and paste to your ad blocker.
 
-### support website
+### Support Websites
 
-to check all support website, please check [filter-item](filter-item) folder.
+To check all support website, please check [website](website) folder.
 
-to apply for new website, report problem, or ask for new feature, please check [issue](../../issues).
+To apply for new websites, report problems, or ask for new features, please check [Issues](../../issues).
 
 
-## contribute
+## Contribute
 
-follow [contribute document](document/contribute.md) to make contribution.
+Follow [Contribute Documents](document/contribute.md) to make contributions.
diff --git a/filter-item/acfun.txt → website/acfun.txt b/filter-item/acfun.txt → website/acfun.txt
diff --git a/filter-item/amap.txt → website/amap.txt b/filter-item/amap.txt → website/amap.txt
diff --git a/filter-item/amazon.cn.txt → website/amazon.cn.txt b/filter-item/amazon.cn.txt → website/amazon.cn.txt
diff --git a/filter-item/amazon.co.jp.txt → website/amazon.co.jp.txt b/filter-item/amazon.co.jp.txt → website/amazon.co.jp.txt
diff --git a/filter-item/amazon.com.txt → website/amazon.com.txt b/filter-item/amazon.com.txt → website/amazon.com.txt
diff --git a/filter-item/baidu-search.txt → website/baidu_search.txt b/filter-item/baidu-search.txt → website/baidu_search.txt
diff --git a/filter-item/bilibili.txt → website/bilibili.txt b/filter-item/bilibili.txt → website/bilibili.txt
diff --git a/filter-item/bing.txt → website/bing.txt b/filter-item/bing.txt → website/bing.txt
diff --git a/filter-item/dmzj.txt → website/dmzj.txt b/filter-item/dmzj.txt → website/dmzj.txt
diff --git a/filter-item/dropbox.txt → website/dropbox.txt b/filter-item/dropbox.txt → website/dropbox.txt
diff --git a/filter-item/duckduckgo.txt → website/duckduckgo.txt b/filter-item/duckduckgo.txt → website/duckduckgo.txt
diff --git a/filter-item/ecosia.txt → website/ecosia.txt b/filter-item/ecosia.txt → website/ecosia.txt
diff --git a/filter-item/feedly.txt → website/feedly.txt b/filter-item/feedly.txt → website/feedly.txt
diff --git a/filter-item/google-search.txt → website/google-search.txt b/filter-item/google-search.txt → website/google-search.txt
diff --git a/filter-item/google-drive.txt → website/google_drive.txt b/filter-item/google-drive.txt → website/google_drive.txt
diff --git a/filter-item/google-map.txt → website/google_map.txt b/filter-item/google-map.txt → website/google_map.txt
diff --git a/filter-item/google-photo.txt → website/google_photo.txt b/filter-item/google-photo.txt → website/google_photo.txt
diff --git a/filter-item/icourse163.txt → website/icourse163.txt b/filter-item/icourse163.txt → website/icourse163.txt
diff --git a/filter-item/inoreader.txt → website/inoreader.txt b/filter-item/inoreader.txt → website/inoreader.txt
diff --git a/filter-item/instapaper.txt → website/instapaper.txt b/filter-item/instapaper.txt → website/instapaper.txt
diff --git a/filter-item/it-home.txt → website/it_home.txt b/filter-item/it-home.txt → website/it_home.txt
diff --git a/filter-item/jd.txt → website/jd.txt b/filter-item/jd.txt → website/jd.txt
diff --git a/filter-item/microsoft-office.txt → website/microsoft_office.txt b/filter-item/microsoft-office.txt → website/microsoft_office.txt
diff --git a/filter-item/netease-cc.txt → website/netease_cc.txt b/filter-item/netease-cc.txt → website/netease_cc.txt
diff --git a/filter-item/netease-music.txt → website/netease_music.txt b/filter-item/netease-music.txt → website/netease_music.txt
diff --git a/filter-item/pixiv.txt → website/pixiv.txt b/filter-item/pixiv.txt → website/pixiv.txt
diff --git a/filter-item/pocket.txt → website/pocket.txt b/filter-item/pocket.txt → website/pocket.txt
diff --git a/filter-item/pornhub.txt → website/pornhub.txt b/filter-item/pornhub.txt → website/pornhub.txt
diff --git a/filter-item/reddit.txt → website/reddit.txt b/filter-item/reddit.txt → website/reddit.txt
diff --git a/filter-item/spotify.txt → website/spotify.txt b/filter-item/spotify.txt → website/spotify.txt
diff --git a/filter-item/stackoverflow.txt → website/stackoverflow.txt b/filter-item/stackoverflow.txt → website/stackoverflow.txt
diff --git a/filter-item/taobao.txt → website/taobao.txt b/filter-item/taobao.txt → website/taobao.txt
diff --git a/filter-item/unsplash.txt → website/unsplash.txt b/filter-item/unsplash.txt → website/unsplash.txt
diff --git a/filter-item/wechat.txt → website/wechat.txt b/filter-item/wechat.txt → website/wechat.txt
diff --git a/filter-item/weibo.txt → website/weibo.txt b/filter-item/weibo.txt → website/weibo.txt
diff --git a/filter-item/youtube.txt → website/youtube.txt b/filter-item/youtube.txt → website/youtube.txt
diff --git a/filter-item/zhihu.txt → website/zhihu.txt b/filter-item/zhihu.txt → website/zhihu.txt