release v0.1.0

README.md

@@ -1,27 +1,60 @@
 # NEU_IPGW
+
 东北大学校园网登录脚本
 
-服务器需要在命令行中进行登录，在github中找到[东北大学非官方跨平台校园网关客户端](https://github.com/neucn/ipgw)这个项目，但是多次尝试总是无法登录，故而自行构建了一个简易版本。
+## 概述
+
+服务器需要在命令行中进行登录，在 github 中找到 [neucn/ipgw](https://github.com/neucn/ipgw) 这个项目，但是多次尝试总是无法登录，故而基于该项目自行构建了一个简易版本。
+
+## 安装
+
+以下安装过程以 Ubuntu 为例，其他系统请使用对应版本。
+
+### 二进制文件安装
+
+1. 从[release 页面](https://github.com/doratiger/neu_ipgw/releases)新版本压缩文件
+2. 解压缩，并赋予执行权限
+3. 部署至`/usr/local/bin`目录
+
+```bash
+## example for ubuntu
+# download
+wget https://github.com/doratiger/neu_ipgw/releases/latest/download/ipgw-linux-amd64.zip
+# unzip and grant
+tar -zxf ./ipgw-linux-amd64.zip
+chmod +x ./NEU_IPGW
+# move
+sudo cp ./NEU_IPGW  /usr/local/bin/
+```
 
-# 用法
+### 源码安装
 
-1. 准备go语言环境，可参考该[博客](https://www.superheaoz.top/2022/10/1036/)的2.3节。
+1. 准备 go 语言环境，可参考该[博客](https://www.superheaoz.top/2022/10/1036/)的 2.3 节。
+2. 编译项目
+3. 部署至`/usr/local/bin`目录
 
-2. 执行仓库中的`main.go`文件
+```bash
+## example for ubuntu
+# download
+git clone https://github.com/DoraTiger/NEU_IPGW.git
+cd NEU_IPGW
+# build
+make all
+# grant
+chmod +x ./build/linux-amd64/NEU_IPGW
+# move
+sudo cp ./build/linux-amd64/NEU_IPGW /usr/local/bin/
+```
 
-    ```shell
-    git clone https://github.com/DoraTiger/NEU_IPGW.git
-    cd NEU_IPGW
-    go run -mod=vendor ./cmd/app/main.go --username username --password password
-    ```
+## 使用
 
-3. 编译项目（可选）
+仅支持登录，离线请通过访问 [https://ipgw.neu.edu.cn:8800/](https://ipgw.neu.edu.cn:8800/) 自行下线。
 
-    ```shell
-    go build -mod=vendor ./cmd/app/main.go
-    ```
+```bash
+NEU_IPGW --username username --password password
+```
 
-# 参考
+## 参考
 
 - [东北大学非官方跨平台校园网关客户端](https://github.com/neucn/ipgw)
-- [NEU API](https://github.com/neucn/neugo)
+- [NEU API](https://github.com/neucn/neugo)