From 140e39f0c01914474a12df4e63d8c3daafd9de14 Mon Sep 17 00:00:00 2001 From: Shengjing Zhu Date: Sat, 23 Jul 2022 17:22:00 +0800 Subject: [PATCH] docs: add install document --- README.md | 2 +- docs/install.md | 25 +++++++++++++++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 docs/install.md diff --git a/README.md b/README.md index 85f4c2b..60414e5 100644 --- a/README.md +++ b/README.md @@ -11,4 +11,4 @@ from proxy server goes to WireGuard network. In local exit mode, the proxy is served on WireGuard network, and the traffic from WireGuard goes to local network. -For detail usage, see . +For detailed usage, see . diff --git a/docs/install.md b/docs/install.md new file mode 100644 index 0000000..096314a --- /dev/null +++ b/docs/install.md @@ -0,0 +1,25 @@ +# Install + +## From source + +```bash +go install github.com/zhsj/wghttp@latest +``` + +## Docker + +Docker images are publish at: + +- [Docker Hub](https://hub.docker.com/r/zhusj/wghttp) + + ```bash + docker pull zhusj/wghttp:latest + + ``` + +- [GitHub](https://github.com/zhsj/wghttp/pkgs/container/wghttp) + + ```bash + docker pull ghcr.io/zhsj/wghttp:latest + + ```