README.md in gollum-site-0.0.1 vs README.md in gollum-site-0.0.2

- old
+ new

@@ -5,12 +5,14 @@ Generates a static site from a Gollum Wiki. ## Installation -TODO +The easiest way to install gollum-site is with RubyGems: + $ [sudo] gem install gollum-site + ## Usage Static sites can be generated using the executable provided: $ gollum-site generate @@ -39,9 +41,18 @@ * `page.content` The formatted content of the page * `page.title` The title of the page * `page.format` The format of the page (textile, org, etc.) * `page.author` The author of the last edit * `page.date` The date of the last edit + +## Default Layout + +A default layout is applied to the root folder for wikis that do not define a +root layout. The default layout is the same used in gollum without the edit +features. It's possible to generate a site without the default template using +the "--no_default_layout" option: + + $ gollum-site --no_default_layout generate ## Example To see gollum-site in action, let's use it to generate a static site from a Gollum Wiki. For this example I will use the Radiant wiki: