diff --git a/README.md b/README.md index dca5dd5..379283b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,48 @@ -# maza-ad-blocking +# Maza ad blocking Simple and efficient local ad blocking throughout the network. +# Run 🏃‍♂️ + +## Update database + +``` bash +maza update +``` + +### Start + +``` bash +sudo maza start +``` + +### Stop + +``` bash +sudo maza stop +``` + +### Status + +``` bash +maza status +``` + +# Install ⚙️ + +## Requirements 👀 + +- bash 4.0 or higher +- curl + +Then you do this. + +``` bash +curl -o maza https://raw.githubusercontent.com/tanrax/maza-ad-blocking/master/maza +chmod +x maza +sudo mv maza /usr/local/bin +``` + # CAUTION - Only compatible with Linux and OSX operating systems.