diff options
| -rw-r--r-- | README.md | 36 |
1 files changed, 33 insertions, 3 deletions
@@ -1,16 +1,46 @@ # Send Over HTTP -Share a file with someone nearby over HTTP using a QR Code printed to the terminal. +Share a file with someone on your local network using QR Code. Inspired by the android app [Share Via HTTP](https://github.com/marcosdiez/shareviahttp). -## Usaage +## Benefits + + - Files are shared directly over the local network. An internet connection is + not required. + - Others can receive the file without installing any special applications. + +## Downsides + + - Others may be able to see the file as the file transfer is not encrypted. + - Some networks, at bars and cafes, will block connecting to others. + +## Usage ``` -go run ./cmd/send-over-http --help +send-over-http --help # Usage of send-over-http [target] # # target - file or directory to share (default: .) # ``` +## Requirements + + - [Golang](go.dev) + +## Install + +You can install the project using Golang's standard install process from the +projects root directory. + +``` +# from the +go install ./cmd/send-over-http +``` + +Or you can build the command into the project's root directory. + +``` +go build ./cmd/send-over-http +``` |