From cf5fd991dfbd37173f38d05fe899f71592a6bbb0 Mon Sep 17 00:00:00 2001 From: frtk Date: Wed, 10 Feb 2016 11:55:20 +0100 Subject: [PATCH] updated README.md --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2eead93..5f1591d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ -# **Multiplayer online Pong Game using nodejs and socket.io** +# **nodePong** + +nodePong is a multiplayer online Pong game based on socket.io and nodejs. +Users can play or spectate games. # Install @@ -9,7 +12,7 @@ clone project from git git clone https://git.tetalab.org/frtk/nodePong.git ``` -nodejs dependencies: packages already included in the "node_modules" directory, or remove dir and install them manually +The app has a few nodejs packages dependencies. If you want to install them manually, follow the instructions below, else use the "node_modules" directory from the cloned project. ``` cd nodePong @@ -23,9 +26,10 @@ npm install socket.io # Parameters -- Server: -Server parameters can be tweaked from "nodePong/server/server_params.js" - - *port*: http and iostream port (default: 8042) +- Server side: + +Parameters can be tweaked from "nodePong/server/server_params.js" + - *port* : http and iostream services port (default: 8042)