Skip to content
Browse files

Add feature list to README

  • Loading branch information...
1 parent fce330f commit a213b9ef75ac535175697dd590394dbab1c56005 @peakpg peakpg committed Jun 21, 2010
Showing with 23 additions and 4 deletions.
  1. +0 −4 README
  2. +23 −0 README.markdown
View
4 README
@@ -1,4 +0,0 @@
-BrowserCMS News Module
-======================
-
-This is the BrowserCMS News Module. This includes...
View
23 README.markdown
@@ -0,0 +1,23 @@
+# News Module for BrowserCMS
+
+A module for handling News Items or Press Releases.
+
+## Features
+
+* News Articles - Contributors can create News Articles with attributes like release date, title, summary, body and an attachment.
+* Friendly URLs - Each news article will have its own unique path created automatically based on its name. Published article can be accessed via these paths.
+* RSS - Visitors can subscribe to an RSS feed that displays the most recent 15 News Articles.
+* Recent News - Contributors can show the most recent few articles (via a Portlet) on any page. The exact # of articles shown can be configured.
+* Archive - Visitors can browse all past articles. By default, the portlet will display articles in reverse chronological order, grouped by month.
+* Categorized - Uses the core Category module to allow each News Article to marked for a particular Category. Both the _Recent News_ and _Archive_ can be configured to show articles only in a particular category.
+* Configurable Views - Each portlet's view can be edited via the CMS UI to be tweaked for any site design.
+* News Section - A top level 'News' section will be created along with several pages designed to handle the above features will be created.
+
+## Installation
+
+The news module uses the standard BrowserCMS module instructions as detailed here: http://guides.browsercms.org/installing_modules.html
+
+### After Installation
+
+The news module will create several pages under a 'News' section in the root of the Sitemap. Contributors will need to publish these pages via the sitemap in order for them to display in the menus.
+

0 comments on commit a213b9e

Please sign in to comment.
Something went wrong with that request. Please try again.