From 60ea4df8bbc44b9fdcdaca4236c67419a55db52b Mon Sep 17 00:00:00 2001 From: xvzc <dev.kwanghoo@gmail.com> Date: Thu, 29 Aug 2024 21:18:26 +0900 Subject: [PATCH] docs: change install.md to quick_start.md --- _docs/{INSTALL.md => QUICK_START.md} | 38 +++++----------------------- _docs/README_ja.md | 2 +- _docs/README_ko.md | 2 +- _docs/README_ru.md | 2 +- _docs/README_zh-cn.md | 2 +- 5 files changed, 11 insertions(+), 35 deletions(-) rename _docs/{INSTALL.md => QUICK_START.md} (68%) diff --git a/_docs/INSTALL.md b/_docs/QUICK_START.md similarity index 68% rename from _docs/INSTALL.md rename to _docs/QUICK_START.md index 8a94add..5086151 100644 --- a/_docs/INSTALL.md +++ b/_docs/QUICK_START.md @@ -1,29 +1,6 @@ -# Installation +# Quick Start -## Homebrew 🍻 -```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 +## Binary SpoofDPI will be installed in `~/.spoofdpi/bin`. To run SpoofDPI in any directory, add the line below to your `~/.bashrc || ~/.zshrc || ...` ```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 ``` -# Run +## Homebrew 🍻 ```bash -spoofdpi +brew install spoofdpi ``` ## Go -You can also install SpoofDPI with `go install` +You can also install SpoofDPI with `go install`. ```bash go install github.com/xvzc/SpoofDPI/cmd/spoofdpi@latest ``` -## Git -You can also build your own +# How to build your own binary + ```bash git clone https://github.com/xvzc/SpoofDPI.git cd SpoofDPI go build ./cmd/... ``` - diff --git a/_docs/README_ja.md b/_docs/README_ja.md index ff23872..3129f8c 100644 --- a/_docs/README_ja.md +++ b/_docs/README_ja.md @@ -9,7 +9,7 @@ ![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png) # 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). # 使用方法 ``` diff --git a/_docs/README_ko.md b/_docs/README_ko.md index 161cab2..c6df6bd 100644 --- a/_docs/README_ko.md +++ b/_docs/README_ko.md @@ -9,7 +9,7 @@ DPI(Deep Packet Inspection) 우회를 위해 고안된 소프트웨어 ![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png) # Installation -SpoofDPI의 설치과정은 [여기](https://github.com/xvzc/SpoofDPI/blob/main/_docs/INSTALL.md)를 참고바랍니다. +SpoofDPI의 설치과정은 [여기](https://github.com/xvzc/SpoofDPI/blob/main/_docs/QUICK_START.md)를 참고바랍니다. # 사용법 ``` diff --git a/_docs/README_ru.md b/_docs/README_ru.md index 8dfd268..0c52d88 100644 --- a/_docs/README_ru.md +++ b/_docs/README_ru.md @@ -9,7 +9,7 @@ ![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png) # 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). # Использование ``` diff --git a/_docs/README_zh-cn.md b/_docs/README_zh-cn.md index 29aa86e..f6ba155 100644 --- a/_docs/README_zh-cn.md +++ b/_docs/README_zh-cn.md @@ -11,7 +11,7 @@ ![image](https://user-images.githubusercontent.com/45588457/148035986-8b0076cc-fefb-48a1-9939-a8d9ab1d6322.png) # 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). # 使用方法