diff --git a/_docs/INSTALL.md b/_docs/INSTALL.md index 222df0d..0c1fae2 100644 --- a/_docs/INSTALL.md +++ b/_docs/INSTALL.md @@ -1,5 +1,32 @@ # Installation +## Homebrew 🍻 +```bash +brew install spoofdpi +``` +### Usage +#### Binary +You can start SpoofDPI with: +```bash +spoofdpi +``` +#### Service +Alternatively you can start SpoofDPI as a service +- with automatic relaunch on startup: + ```bash + brew services start spoofdpi + ``` +- without: + ```bash + brew services run spoofdpi + ``` +##### Logs +When running as a service, SpoofDPI writes logs to +```text +$HOMEBREW_PREFIX/var/log/spoofdpi/output.log +$HOMEBREW_PREFIX/var/log/spoofdpi/error.log +``` + ## Binary SpoofDPI will be installed in `~/.spoof-dpi/bin`. To run SpoofDPI in any directory, add the line below to your `~/.bashrc || ~/.zshrc || ...` @@ -30,7 +57,6 @@ curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bas curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mipsle ``` - ## Go You can also install SpoofDPI with `go install` ```bash