docs: refactor docs

This commit is contained in:
xvzc 2024-08-27 12:14:54 +09:00
parent 97d9fb157b
commit 7e70f10049

View File

@ -4,34 +4,30 @@
```bash
brew install spoofdpi
```
### Usage
#### Binary
You can start SpoofDPI with:
### Run with binary
```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
### Run as a service
```bash
brew services start spoofdpi # This will automatically relaunch SpoofDPI on startup
```
```bash
brew services run spoofdpi # This will not relaunch SpoofDPI on startup
```
### Logs
If you run SpoofDPI as a service, it will write logs into the files below
```bash
$HOMEBREW_PREFIX/var/log/spoofdpi/output.log
$HOMEBREW_PREFIX/var/log/spoofdpi/error.log
```
## Binary
SpoofDPI will be installed in `~/.spoof-dpi/bin`.
## Curl
SpoofDPI will be installed in `~/.spoofdpi/bin`.
To run SpoofDPI in any directory, add the line below to your `~/.bashrc || ~/.zshrc || ...`
```
export PATH=$PATH:~/.spoof-dpi/bin
```bash
export PATH=$PATH:~/.spoofdpi/bin
```
---
```bash
@ -57,17 +53,22 @@ 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
```
# Run
```bash
spoofdpi
```
## Go
You can also install SpoofDPI with `go install`
```bash
$ go install github.com/xvzc/SpoofDPI/cmd/spoof-dpi@latest
go install github.com/xvzc/SpoofDPI/cmd/spoofdpi@latest
```
## Git
You can also build your own
```bash
$ git clone https://github.com/xvzc/SpoofDPI.git
$ cd SpoofDPI
$ go build ./cmd/...
git clone https://github.com/xvzc/SpoofDPI.git
cd SpoofDPI
go build ./cmd/...
```