Skip to content

Commit

Permalink
WebBlocker: README: Update all src/files (image) and update the readm…
Browse files Browse the repository at this point in the history
…e for better understanding of new features.

Change-Id: 5a4a048, 11656e9, 7c96f92

Signed-off-by: KARTHIK LAL <[email protected]>
  • Loading branch information
karthik558 committed May 30, 2024
1 parent 7c96f92 commit 963f06f
Show file tree
Hide file tree
Showing 10 changed files with 24 additions and 9 deletions.
33 changes: 24 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# **WebBlockerScript / WebBlockerCMD**
# **WebBlockerProxy | WebBlockerScript**

<!-- Banner Image-->
![Web Blocker Script Banner](assets/banner.png)
![Web Blocker Script Banner](assets/imgBanner/WebBlockerProxy.png)

![](https://img.shields.io/github/license/karthik558/WebBlockerScript?style=for-the-badge)
![](https://img.shields.io/github/forks/karthik558/WebBlockerScript?style=for-the-badge)
Expand All @@ -25,17 +25,25 @@ WebBlockerScript is a simple command-line tool written in Batch script that allo
<!-- Script Image-->
<table>
<tr>
<td><img src="assets/script_home.png" width="100%" alt="Web Blocker Script Home"></td>
<td><img src="assets/script_exit.png" width="100%" alt="Web Blocker Script Exit"></td>
<td><img src="assets/imgReadme/1.png" width="140%"></td>
<td><img src="assets/imgReadme/2.png" width="140%"></td>
<td><img src="assets/imgReadme/4.png" width="140%"></td>
<td><img src="assets/imgReadme/3.png" width="140%"></td>
<td><img src="assets/imgReadme/5.png" width="140%"></td>
</tr>
</table>

## Usage

- **1. Clone the repository (or download from the releases page)** - `git clone https://github.com/karthik558/WebBlockerScript`
- **2. Run the script as administrator. (Right-click on the script and select "Run as administrator")**
- **3. Select an option from the menu. (1-9)**
- **4. That's it! The script will do the rest.**
- **3. Select an option from the menu. (1-13)**
- **4. Follow the on-screen instructions to block/unblock websites, add/remove websites to block, backup/restore hosts file, etc.**
- **5. Always flush the DNS cache after blocking/unblocking a website. (Option 8)**
- **6. Use Task Scheduler to run the script at a scheduled time to block websites. (Option 10)**
- **7. Select a custom block list file to block websites. (Option 11)**
- **8. Update the block list file with the latest version from the GitHub repository. (Option 12)** (If block.txt is not present in the same directory, then run the script with the internet connection to download the latest block list file. **(Option 12))**
- **9. That's it! The script will do the rest.**

## Overview of the Menu
- **1. Block a website** - Blocks all the websites that are stored in the `WebBlockerScript.cmd` file.
Expand All @@ -46,7 +54,11 @@ WebBlockerScript is a simple command-line tool written in Batch script that allo
- **6. Restore hosts file** - Restores the hosts file from the backup.
- **7. View host file** - Displays the contents of the hosts file in the notepad.
- **8. Flush DNS cache** - Flushes the DNS cache. (Always recommended after blocking/unblocking a website)
- **9. Exit** - Exits the script.
- **9. Unblock WhatsApp** - Unblocks WhatsApp by removing the block from the hosts file. (Quick access to WhatsApp)
- **10. Set Blocking Schedule** - Allows you to set a schedule for blocking websites. (Use Task Scheduler to run the script at the scheduled time)
- **11. Select Block List File** - Allows you to select a custom block list file to block websites.
- **12. Update Block List File** - Updates the block list file with the latest version from the GitHub repository.
- **13. Exit** - Exits the script.

## Features

Expand All @@ -55,8 +67,11 @@ WebBlockerScript is a simple command-line tool written in Batch script that allo
- **3. Remove blocked websites.**
- **4. Backup and restore hosts file.**
- **5. Easy to use menu system.**
- **6. No technical knowledge or expertise required.**
- **6. No technical knowledge or expertise required. (1-4)**
- **7. Free and open-source.**
- **8. Regular updates and improvements.**
- **9. Block websites on a schedule.**
- **10. Select custom block list file.**

## Contribution

Expand All @@ -65,4 +80,4 @@ WebBlockerScript is a simple command-line tool written in Batch script that allo

## Developer Information

This project was developed by [KARTHIK LAL](https://github.com/karthik558). You can contact me at [[email protected]](mailto:[email protected]) for any queries or suggestions.
This project was developed by [KARTHIK LAL](https://karthiklal.in). You can contact me at [[email protected]](mailto:[email protected]) for any queries or suggestions.
Binary file removed assets/banner.png
Binary file not shown.
Binary file added assets/imgBanner/WebBlockerProxy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/imgReadme/1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/imgReadme/2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/imgReadme/3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/imgReadme/4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/imgReadme/5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed assets/script_exit.png
Binary file not shown.
Binary file removed assets/script_home.png
Binary file not shown.

0 comments on commit 963f06f

Please sign in to comment.