Skip to content

Commit 59ae726

Browse files
author
Your Name
committed
Added Readme file
1 parent 45d0c14 commit 59ae726

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Adhost
2+
3+
Introducing Adhost2, a lightweight ad blocker that uses a simple shell script to set up the host file. With no bells and whistles, Adhost2 efficiently blocks unwanted ads on your system, providing a faster and smoother browsing experience. Whether you're tired of pop-ups, banners, or other pesky ads, Adhost2 has got you covered.
4+
5+
Here's a README file in Markdown format based on the script you provided:
6+
7+
## How it works
8+
9+
Adhost2 is a script that updates the /etc/hosts file on a Linux system with a list of hosts obtained from a file or custom input. It can be used to block or redirect hosts.
10+
11+
## Usage
12+
13+
Run the script with sudo privileges:
14+
15+
```bash
16+
sudo ./adhost2
17+
```
18+
19+
If you want to use a custom host list, specify the file path using the -h option:
20+
21+
```bash
22+
sudo ./adhost2 -h /path/to/custom-host-list
23+
```
24+
25+
To uninstall Adhost2 and restore the original /etc/hosts file, run:
26+
27+
```bash
28+
sudo ./adhost2 uninstall
29+
```
30+
31+
## Prerequisites
32+
33+
- Linux system
34+
- Curl
35+
36+
## Notes
37+
38+
- The script must be run from the hosts directory (hint: from the unzip dir).
39+
- If you interrupt the script with Ctrl+C, it will restore the original /etc/hosts file.
40+
- The script must be run with sudo privileges.
41+
- The default host list is /usr/share/adhost/adhost2.
42+
43+
## License
44+
45+
This script is licensed under the MIT License.

0 commit comments

Comments
 (0)