Browse Source

Update readme

Roman Matiasko 8 years ago
parent
commit
1d343f914d
1 changed files with 20 additions and 2 deletions
  1. 20 2
      README.md

+ 20 - 2
README.md

@@ -5,28 +5,46 @@ A lightweight, real-time chess app built in [Node](http://nodejs.org/), [Express
 
 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
+# 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
 ```sh
 npm install -g nodemon # if you don't have nodemon installed yet
+export NODE_ENV=development
 nodemon bin/www
 ```
-* Run gulp if you want to recompile static assets when you save a file
+
+* If you want to recompile static assets when you save a file
 ```sh
 npm run build
 ```
+
+* Running tests
+```sh
+npm test
+```
+
 * App will run on **localhost:3000**
 
 License