windhamdavid 4 years ago
parent
commit
aaf2caea60
1 changed files with 8 additions and 25 deletions
  1. 8 25
      README.md

+ 8 - 25
README.md

@@ -1,53 +1,36 @@
-Reti Chess
+####Chess-IO
 ==========
 
-A lightweight, real-time chess app built in [Node](http://nodejs.org/), [Express](http://expressjs.com/), [Socket.IO](http://socket.io/), [React](http://facebook.github.io/react/), [Flux](http://facebook.github.io/flux/) and [Immutable](http://facebook.github.io/immutable-js/). Reti Chess also uses [chess.js](https://github.com/jhlywa/chess.js) for move validation and check/mate/draw detection.
+My fork of [Reti-Chess](https://github.com/romanmatiasko/reti-chess)
+Built with [Node](https://github.com/nodejs/node), [Express](https://github.com/strongloop/express), [Socket.IO](https://github.com/socketio/socket.io), [React](https://github.com/facebook/react), [Flux](https://github.com/facebook/flux) and [Immutable](https://github.com/facebook/immutable-js), and [chess.js](https://github.com/jhlywa/chess.js).
 
-You can play the game on [www.retichess.com](http://www.retichess.com/).
 
-Warning
--------
-
-The app is no longer being developed.
-It works with node v4, but many things are outdated (it uses react 0.13.1 and mixins, no hot reloading, etc.)
-
-If you want to run it locally (with node **v4.2**):
-
-* Clone the repo
-
-* Install dependencies
 ```sh
 npm install
-# create empty logfile for winston logger
 mkdir logs
 touch logs/games.log
-```
-
-* Run the server
-```sh
 npm start
 ```
 
-* Preferred way is to run the server with nodemon
+- with nodemon
 ```sh
 npm install -g nodemon # if you don't have nodemon installed yet
 export NODE_ENV=development
 nodemon bin/www
 ```
 
-* If you want to recompile static assets when you save a file
+- recompile static assets on save
 ```sh
 npm run build
 ```
 
-* Running tests
+- tests
 ```sh
 npm test
 ```
 
-* App will run on **localhost:8888**
 
-License
+####License
 -------
 
-Available under [the MIT License (MIT)](./LICENSE.md).
+Available under [the MIT License (MIT)](./LICENSE.md).