diff --git a/README.md b/README.md new file mode 100644 index 0000000..ed3ab26 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +Pipeserver is a simple webserver that uses sockets to distribute text received on stdin to connected webpages. By piping other processes into pipeserver, you can stream their messages and eventually produce customized javascript interfaces based on the content. + + +Installation of prerequisites: + + pip3 install aiohttp aiohttp_jinja2 + +Usage: + + python3 pipeserver --template pipeserver.html + +But of course the fun is to pipe into it... + + liquidsoap -v my.liq | python3 pipeserver --template pipeserver.html