From 5ea944695d1696e30653728fe7adc9e6616a4ee4 Mon Sep 17 00:00:00 2001 From: Diff Date: Wed, 24 Mar 2021 04:36:38 +0000 Subject: [PATCH] Add README, tweak wording in main package description. --- README.md | 25 +++++++++++++++++++++++++ main.go | 6 +++--- 2 files changed, 28 insertions(+), 3 deletions(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..0cffb47 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +Ruff provides a pop-up web server to Retrieve/Upload Files Fast over LAN, +inspired by WOOF (Web Offer One File) by Simon Budig. + +It's based on the idea that not every device has , but just about every device that can network has an HTTP client, +making a hyper-simple HTTP server a viable option for file transfer with +zero notice or setup as long as *somebody* has a copy of RUFF. + +Why create RUFF when WOOF exists? WOOF is no longer in the debian repos and +it's easier to `go get` a tool than it is to hunt down Simon's website for +the latest copy. + +## Installation + +`go get git.tilde.town/diff/ruff` + +## Usage + +Assuming $GOPATH is in $PATH: + +`ruff "cool thing.jpg" # to send a cool file` + +and + +`ruff -u # to receive a cool file` diff --git a/main.go b/main.go index 286b0c4..ad0af23 100644 --- a/main.go +++ b/main.go @@ -1,8 +1,8 @@ // Ruff provides a pop-up web server to Retrieve/Upload Files Fast over // LAN, inspired by WOOF (Web Offer One File) by Simon Budig. // -// It's based on the principle that not everyone has , just about every device that can network has an HTTP client, +// It's based on the idea that not every device has , but just about every device that can network has an HTTP client, // making a hyper-simple HTTP server a viable option for file transfer with // zero notice or setup as long as *somebody* has a copy of RUFF. // @@ -207,4 +207,4 @@ func setupUpload(server *http.Server, conf Config) { return } }) -} \ No newline at end of file +}