diff --git a/README.md b/README.md new file mode 100644 index 0000000..43b25cf --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# QR Serve + +This is a small windows utility which serves a file over LAN, +showing a QR code which can be scanned by other devices on the +same network to retrieve the file. + +## How to use + +Drag and drop the file you want to serve to QR Serve, or right +click the file and choose "Open with...", then find and pick +the QR Serve binary. + +## Building QR Serve + +- Install Go and project dependencies +- Get rsrc - `go install github.com/akavel/rsrc` +- Run `release.sh` \ No newline at end of file