From 655a58494192dddac21326167384b445c2c26c7b Mon Sep 17 00:00:00 2001 From: jacobsalmela Date: Sat, 13 Jun 2015 22:26:19 -0500 Subject: [PATCH] Updated README to reflect changes --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 0d99acf4..a2c6af7a 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,27 @@ # Raspberry Pi Ad Blocker **A black hole for ads, hence Pi-hole** -![Pi-hole](http://www.hdwallpapersimages.com/wp-content/uploads/2014/03/Black-Hole-Images-540x303.jpg) +![Pi-hole](http://i.imgur.com/wd5ltCU.png) -The Pi-hole is a DNS/Web server that will **block ads for any device**. +The Pi-hole is a DNS/Web server that will **block ads for any device on your network**. ## Coverage Featured on [MakeUseOf](http://www.makeuseof.com/tag/adblock-everywhere-raspberry-pi-hole-way/) and [Lifehacker](http://lifehacker.com/turn-a-raspberry-pi-into-an-ad-blocker-with-a-single-co-1686093533)! ## Automated Install +### Make sure to set a **static** IP address before running this!! On a clean installation of Raspbian, you can run this command to **auto-install the Pi-hole**. Once installed, configure any device to use the Raspberry Pi as your DNS server and the ads will be blocked. ```curl -s "https://raw.githubusercontent.com/jacobsalmela/pi-hole/master/automated%20install/basic-install.sh" | bash``` ## Gravity -The [gravity-adv.sh](https://github.com/jacobsalmela/pi-hole/blob/master/gravity-adv.sh) does most of the magic. The script pulls in ad domains from many sources and compiles them into a single list of [over 120,000 entries](http://jacobsalmela.com/blocking-ads-from-120000-domains/). +The [gravity.sh](https://github.com/jacobsalmela/pi-hole/blob/master/gravity.sh) does most of the magic. The script pulls in ad domains from many sources and compiles them into a single list of [over 900,000 entries](http://jacobsalmela.com/blocking-ads-from-120000-domains/). + +### How It Works +A technical and detailed description can be found [here](http://jacobsalmela.com/block-millions-ads-network-wide-with-a-raspberry-pi-hole-2-0)! ## Whitelist and blacklist -You can add a whitelist or blacklist in ```/etc/pihole/``` and the script will apply those files automatically. +You can add a `whitelist.txt` or `blacklist.txt` in `/etc/pihole/` and the script will apply those files automatically. ## Other Operating Systems -This script will work for other UNIX-like systems with some slight **modifications**. As long as you can install dnsmasq and a Webserver, it should work OK. The automated install only works for a clean install of Raspiban right now since that is how the project originated. - -## Optimizations -I am working on some great optimizations to allow the script to run much faster. I also have a bunch of new sources for ad domains but I still need to see if the lists are OK. +This script will work for other UNIX-like systems with some slight **modifications**. As long as you can install `dnsmasq` and a Webserver, it should work OK. The automated install only works for a clean install of Raspiban right now since that is how the project originated. \ No newline at end of file