README.md in rack-blogengine-0.1.2 vs README.md in rack-blogengine-0.1.3

- old
+ new

@@ -57,9 +57,48 @@ `[content][/content]` - your content ### Hint For a root document (http://pathtoapp.tld/) path should be empty ([path]:[/path]) +### Operators + +In version 0.1.2 operator handling is included. +To use this new feature you have to create a operator directory in your rackblog folder. +In this directory create your operators (.rb files) with following skeleton + +```ruby +module UserOperator +end +``` + +Your operators are normal ruby methods defined in this module. +Available params are documents & html + +Param documents: +An Array with document objects. +This Document objects has following attributes: path, title, html + +Param html: +The content of the file where the operator was included + +#### Example + +```ruby +module UserOperator + def show_nav + end +end +``` + +In your layout.html then + +```html +<div class="nav"> + {% show_nav %} +</div> +``` + + ## Contributing 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Add some feature'`)