Updated README to Markdown

This commit is contained in:
2018-03-09 17:00:34 -05:00
parent 5c73594498
commit f162aa8990
2 changed files with 24 additions and 68 deletions

24
README.md Normal file
View File

@@ -0,0 +1,24 @@
# Air Hockey
A simple browser-based air hockey game using socket.io with Electron desktop client
## Development Environment
node 8.9.4
npm 5.7.1
Tested on MacOS 10.13.2
## Dependencies
node.js, Electron, socket.io
# Installation Instructions
..* Clone to local machine
..* Run _npm install_ from root directory and Electron Client directory to install node module Dependencies
# Running the App
## Starting the server
..* Execute _node app.js_ from root directory to start the app server
## Browser Client
..* Navigate to http://localhost:3000/airhockey.html from your browser
## Electron Client
..* Execute _npm start_ from inside the _Electron Client_ directory to launch the Electron Client