diff --git a/README.md b/README.md index eb8bcdd..e9b7931 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Tested on MacOS 10.13.2 node.js, Electron, socket.io # Installation Instructions -* Clone to local machine +.. * Clone to local machine * Run _npm install_ from root directory and Electron Client directory to install node module Dependencies # Running the App @@ -22,3 +22,12 @@ node.js, Electron, socket.io ### Electron Client * Execute _npm start_ from inside the _Electron Client_ directory to launch the Electron Client + +### Usage +* To join the game, click "Join Game" and enter your name +* Once another player has joined from another browser window, the game will begin and puck will pick a random direction to travel +* Use the arrow keys on your keyboard to move your paddle +* The paddle will not move until 2 players are present +* When the puck enters one of the purple goals on either end, the opposing player will score a point and the player's positions will be reset, with the puck traveling in a new random direction +* If you attempt to join a game with 2 players, you will not be allowed, but your name will appear in the Spectator box below +* You can toggle collision and goal sounds using the Toggle Sounds button