From 68105ab53830a5cff38f9edcb73ff9c367f751c7 Mon Sep 17 00:00:00 2001 From: Laura Date: Sat, 21 Jun 2025 00:15:01 +0200 Subject: [PATCH] UPdate readme --- README.md | 16 +++++++--------- test.cmd | 2 +- test.sh | 2 +- 3 files changed, 9 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 538d4ac..b57588e 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,30 @@ -# UP -UP is a simple file transfer tool that acts as a drop-in replacement for `scp` and `sftp`. It sends data over HTTPS for much faster uploads without any extra setup. The client uses your existing SSH keys and reads `~/.ssh/config` so you can keep working with the host aliases you already have. +UP is a simple file transfer tool that acts as a drop-in replacement for `scp` and `sftp`. It sends data over HTTPS for much faster uploads without any extra setup. Up uses your existing SSH keys and reads `~/.ssh/config` so you can keep working with the host aliases you already have. ## Why UP? - Transfers are noticeably quicker than traditional `scp` or `sftp`. - No setup: use the same SSH keys and host aliases you already have. -- Small client and server binaries. +- Small single binary for sending and receiving. ## Quick Start Pre-built binaries for common operating systems are available in the [releases](https://github.com/coalaura/up/releases/latest). Choose the download that matches your OS and architecture or build the latest development version yourself: ```bash -go build -o server ./server -go build -o up ./client +go build -o up . ``` Start the server (listens on port 7966) and then upload a file: ```bash -./server +./up receive -./up very_big.tar.xz localhost:7966 +./up send very_big.tar.xz localhost:7966 ``` -Uploaded files are stored under the server's `files/` directory. The client will prompt to trust the server's certificate on first use and will remember it afterwards. Up is built to work behind reverse proxies like nginx. +Uploaded files are stored under the server's `files/` directory. Up will prompt to trust the server's certificate on first use and will remember it afterwards. Up is built to work behind reverse proxies like nginx. ## License -This project is licensed under the GNU General Public License v3.0 License. See [LICENSE](LICENSE) for details. +This project is licensed under the GNU General Public License v3.0 License. See [LICENSE](LICENSE) for details. \ No newline at end of file diff --git a/test.cmd b/test.cmd index 8a6adc8..445dfc7 100644 --- a/test.cmd +++ b/test.cmd @@ -1,3 +1,3 @@ @echo off -go run .\client test.bin localhost:7966 \ No newline at end of file +go run . send test.bin localhost:7966 \ No newline at end of file diff --git a/test.sh b/test.sh index f61493b..b99cae6 100755 --- a/test.sh +++ b/test.sh @@ -1,3 +1,3 @@ #!/bin/bash -go run ./client example.webp localhost:7966 +go run . send example.webp localhost:7966