diff --git a/README.md b/README.md index 40485cedae..e28a0681c3 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,25 @@ # NodeBB **NodeBB** is a robust nodejs driven forum built on a redis database. It is powered by web sockets, and is compatible down to IE8. +![NodeBB Screenshot](http://i.imgur.com/mxRmLAg.png) + +![NodeBB Login Page (with Social Logins)](http://i.imgur.com/q5tUUHW.png) + +## Requirements + +NodeBB requires a version of Node.js at least 0.8 or greater, and a Redis version 2.6 or greater. + ## Installation -NodeBB is powered by Node.js with a Redis database. They must be installed prior in order for NodeBB to work. `build-essential` exposes the build environment for `bcrypt` compilation. +First, we install our base software stack. `build-essential` is required as it exposes the build environment for `bcrypt` compilation, we won't be compiling anything manually. - # apt-get install nodejs redis-server npm build-essential + # apt-get install git nodejs redis-server npm build-essential + $ cd /path/to/nodebb/install/location + $ git clone git://github.com/designcreateplay/NodeBB.git nodebb Next, obtain all of the dependencies required by NodeBB: + $ cd nodebb $ npm install Now we ensure that the configuration files are properly set up. NodeBB runs on port 4567 by default. The client side config can be set up thusly: