diff --git a/README.md b/README.md new file mode 100644 index 0000000..da75155 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# MU-GO + +This project helps you to run a HTTP server and publish videos using an API. +A client gives you a way to play and download these videos. + +## Installation + +Builds are available for Linux (64 bits). + +Download the latest binary from [releases](https://gitnet.fr/deblan/mu-go/releases). + +`mpv` and `wget` are required. + +## Usage + +### Server side + +``` +muget serve --listen 127.0.0.1 --port 4000 --directory ./ --api-url http://127.0.0.1:4000 +``` + +Arguments are optional. + +In case of a reverse proxy, edit the API Url, eg: `--api-url https://videos.example.com`. + +### Client side + +``` +muget play --api-url http://127.0.0.1:4000 +muget download --api-url http://127.0.0.1:4000 +``` +Arguments are optionals. + +In case of a reverse proxy, edit the API Url, eg: `--api-url https://videos.example.com`. + +By default, videos are listed from oldest to newer. You can sort by name this using `--order name`. +To search videos by name, use `--name xxxxx`.