From 8b89da94c71430f3896fdf26efa4e6c2f7ea5612 Mon Sep 17 00:00:00 2001 From: Thai Pangsakulyanont Date: Tue, 31 Aug 2021 20:17:01 +0700 Subject: [PATCH] Update README.md --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 888bc05..ad6cfbf 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,19 @@ # mosh-static -[WIP] Static builds of mosh + +An unofficial static binary distribution of [mobile-shell/mosh](https://github.com/mobile-shell/mosh) which can be dropped into a remote server. + +Releasing is automated by GitHub Actions — [this GitHub Actions workflow](https://github.com/dtinth/mosh-static/blob/main/.github/workflows/autobuild.yml) clones `mosh`’s source code, compiles it inside an Alpine Docker image, and creates [a GitHub release with the binary](https://github.com/dtinth/mosh-static/releases/latest). + +> **Note:** Only x86-64 architecture is supported. I do not plan to support other architectures or maintain this repository. Please feel free to fork. If there is an actively maintained fork, please let me know and I will point people there. + +## Using the binaries + +```sh +# On the server +wget https://github.com/dtinth/mosh-static/releases/latest/download/mosh-server +chmod +x mosh-server + +# On the client +mosh --server=./mosh-server @ +``` +