diff --git a/README.md b/README.md index 185aff3..47cc557 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,19 @@ -# pixelnode -Web based Pixelflut server in node.js and socket.io +# PixelNode +Web based Pixelflut server using node.js and socket.io + +Inspired by https://github.com/defnull/pixelflut + +It's only a bit of fun. His servers are much better ;P + +## Using +### Setup +Install node.js and download scripts + git clone https://github.com/clerie/pixelnode + sudo apt-get nodejs + nodejs index + +Open localhost:61813 in a browser (you can use multiple). + +### Play +Use PixelNode with the same protocol as Pixelflut: +https://github.com/defnull/pixelflut#pixelflut-protocol