From a05f17b70217b0dffb72e4c5ebe00cfc0bee943a Mon Sep 17 00:00:00 2001 From: psychobunny Date: Tue, 11 Feb 2014 15:01:32 -0500 Subject: [PATCH] updated README: added links to blog, plugins, themes; added new screenshots (old ones were 0.2x); other minor changes --- README.md | 28 ++++++++++++++++++++-------- 1 file changed, 20 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 760f2fcbd8..8d5d32e043 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,41 @@ # NodeBB -**NodeBB** is a robust Node.js driven forum built on a redis database. It is powered by web sockets, and is compatible down to IE8. +**NodeBB** is a robust Node.js driven forum built on a Redis database. It is powered by web sockets, and is compatible down to IE8. * [NodeBB Homepage](http://www.nodebb.org/ "NodeBB") -* [Demo & Meta Discussion](http://try.nodebb.org) +* [Demo & Meta Discussion](http://community.nodebb.org) +* [NodeBB Blog](http://blog.nodebb.org) * [Wiki Guides](https://github.com/designcreateplay/NodeBB/wiki) - includes setup for other platforms * [Join us on IRC](https://kiwiirc.com/client/irc.freenode.net/nodebb) - #nodebb on Freenode * [Follow on Twitter](http://www.twitter.com/NodeBB/ "NodeBB Twitter") * [Like us on Facebook](http://www.facebook.com/NodeBB/ "NodeBB Facebook") +* [Get Plugins](http://community.nodebb.org/category/7/nodebb-plugins "NodeBB Plugins") +* [Get Themes](http://community.nodebb.org/category/10/nodebb-themes "NodeBB Themes") -![NodeBB Main Category Listing](http://i.imgur.com/zRdzCcj.png) - -![NodeBB Topic Page](http://i.imgur.com/ZC8W39a.png) ## How can I follow along/contribute? * Our feature roadmap is hosted on the project wiki's [Version History / Roadmap](https://github.com/designcreateplay/NodeBB/wiki/Version-History-%26-Roadmap) -* If you are a developer, feel free to check out the source and submit pull requests. -* If you are a designer, NodeBB needs themes! NodeBB will accept any LESS or CSS file and use it in place of the default Twitter Bootstrap theme. Consider extending Bootstrap themes by extending the base bootstrap LESS file. +* If you are a developer, feel free to check out the source and submit pull requests. We also have a wide array of [plugins](http://community.nodebb.org/category/7/nodebb-plugins) which would be a great starting point for learning the codebase. +* If you are a designer, [NodeBB needs themes](http://community.nodebb.org/category/10/nodebb-themes)! NodeBB's theming system allows extention of the base templates as well as styling via LESS or CSS. NodeBB's base theme utilizes [Bootstrap 3](http://getbootstrap.com/) but themes can choose to use a different framework altogether. +* Please don't forget to like, follow, and star our repo! Join our growing [community](http://community.nodebb.org) to keep up to date with the latest NodeBB development. + + +## Screenshots + +![Convoe Homepage powered by NodeBB](http://i.imgur.com/tbAxIyb.jpg) +![Convoe Topics powered by NodeBB](http://i.imgur.com/FLOUuIq.png) +![Kano Homepage powered by NodeBB](http://i.imgur.com/Ud1LrfI.png) +![NodeBB Vanilla Topic Page](http://i.imgur.com/ZC8W39a.png) +![NodeBB Homepage (Pewter Theme)](http://i.imgur.com/o90kVPi.png) +![NodeBB Sidemenu (Pewter Theme)](http://i.imgur.com/AaRRrU2.png) +Credit: [Convoe](http://www.convoe.com), [Kano](http://www.kano.me). ## Requirements NodeBB requires the following software to be installed: * A version of Node.js at least 0.8 or greater -* Redis, version 2.6 or greater or MongoDB, version 2.4 or greater +* Redis, version 2.6 or greater **or** MongoDB, version 2.4 or greater * nginx, version 1.3.13 or greater (**only if** intending to use nginx to proxy requests to a NodeBB) ## Installation