docs: change install.md to quick_start.md

This commit is contained in:
xvzc 2024-08-29 21:18:26 +09:00
parent f0cf07d167
commit 60ea4df8bb
5 changed files with 11 additions and 35 deletions

View File

@ -1,29 +1,6 @@
# Installation # Quick Start
## Homebrew 🍻 ## Binary
```bash
brew install spoofdpi
```
### Run with binary
```bash
spoofdpi
```
### 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
```
## Curl
SpoofDPI will be installed in `~/.spoofdpi/bin`. SpoofDPI will be installed in `~/.spoofdpi/bin`.
To run SpoofDPI in any directory, add the line below to your `~/.bashrc || ~/.zshrc || ...` To run SpoofDPI in any directory, add the line below to your `~/.bashrc || ~/.zshrc || ...`
```bash ```bash
@ -53,22 +30,21 @@ 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 curl -fsSL https://raw.githubusercontent.com/xvzc/SpoofDPI/main/install.sh | bash -s linux-mipsle
``` ```
# Run ## Homebrew 🍻
```bash ```bash
spoofdpi brew install spoofdpi
``` ```
## Go ## Go
You can also install SpoofDPI with `go install` You can also install SpoofDPI with `go install`.
```bash ```bash
go install github.com/xvzc/SpoofDPI/cmd/spoofdpi@latest go install github.com/xvzc/SpoofDPI/cmd/spoofdpi@latest
``` ```
## Git # How to build your own binary
You can also build your own
```bash ```bash
git clone https://github.com/xvzc/SpoofDPI.git git clone https://github.com/xvzc/SpoofDPI.git
cd SpoofDPI cd SpoofDPI
go build ./cmd/... go build ./cmd/...
``` ```

View File

@ -9,7 +9,7 @@
![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png) ![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png)
# Installation # Installation
See the installation guide for SpoofDPI [here](https://github.com/xvzc/SpoofDPI/blob/main/_docs/INSTALL.md). See the installation guide for SpoofDPI [here](https://github.com/xvzc/SpoofDPI/blob/main/_docs/QUICK_START.md).
# 使用方法 # 使用方法
``` ```

View File

@ -9,7 +9,7 @@ DPI(Deep Packet Inspection) 우회를 위해 고안된 소프트웨어
![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png) ![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png)
# Installation # Installation
SpoofDPI의 설치과정은 [여기](https://github.com/xvzc/SpoofDPI/blob/main/_docs/INSTALL.md)를 참고바랍니다. SpoofDPI의 설치과정은 [여기](https://github.com/xvzc/SpoofDPI/blob/main/_docs/QUICK_START.md)를 참고바랍니다.
# 사용법 # 사용법
``` ```

View File

@ -9,7 +9,7 @@
![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png) ![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png)
# Installation # Installation
See the installation guide for SpoofDPI [here](https://github.com/xvzc/SpoofDPI/blob/main/_docs/INSTALL.md). See the installation guide for SpoofDPI [here](https://github.com/xvzc/SpoofDPI/blob/main/_docs/QUICK_START.md).
# Использование # Использование
``` ```

View File

@ -11,7 +11,7 @@
![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png) ![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png)
# Installation # Installation
See the installation guide for SpoofDPI [here](https://github.com/xvzc/SpoofDPI/blob/main/_docs/INSTALL.md). See the installation guide for SpoofDPI [here](https://github.com/xvzc/SpoofDPI/blob/main/_docs/QUICK_START.md).
# 使用方法 # 使用方法