diff --git a/README.md b/README.md index fc86612..de264c4 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,39 @@ -videostreamer provides a way to stream video from an input source to HTTP. It -remuxes a given video input into an MP4 container which it then streams to any -connecting clients. This provides the ability to stream an input source that -may have limited connections, is not accessible via HTTP, or is not easily -embeddable in a website. +# videostreamer +videostreamer provides a way to stream video from an input source to HTTP. +It remuxes a video input into an MP4 container which it streams to +connecting clients. This provides the ability to stream an input source +that may have limited connections (it opens at most one connection to the +input), is not accessible via HTTP, or is not easily embeddable in a +website. -# Background +## Requirements + * ffmpeg (libavcodec, libavformat, libavdevice, libavutil, libswresample). I + developed using 3.2.2. On Debian this is in the package libavutil-dev. + * C compiler. I developed using gcc 6.2.1. + * Go. I developed using 1.7.3. + + +## Installation + * go get github.com/horgh/videostreamer + * go build + * Place index.html somewhere accessible. Update the `