Update readme.md

Author: skttl

readme.md

@@ -1,7 +1,50 @@
 # Our.Umbraco.BlockListMvc 
 WIP port of the [hijacking feature from Doc Type Grid Editor](https://github.com/skttl/umbraco-doc-type-grid-editor/blob/develop/docs/developers-guide.md#doctypegrideditorsurfacecontroller), to be used when rendering Block Lists in Umbraco.
 
-Still very much work in progress, but to try it out, you render a block list like this:
+Still very much work in progress
+
+
+---
+
+
+
+#### BlockListMvcSurfaceController
+
+If you are not the type of developer that likes to put business logic in your views, then the ability to have a controller for you partial view is a must. To help with this, the **BlockListMvc** comes with a base surface controller you can used called `BlockListMvcSurfaceController`.
+
+Simply create your controller inheriting from the above class, giving it a class name of `{DocTypeAlias}SurfaceController` and an action name of `{DocTypeAlias}` and then **BlockListMvc** will automatically wire it up for you and use it at render time.
+
+```csharp
+public class TestDocTypeSurfaceController
+	: BlockListMvcSurfaceController
+{
+	public ActionResult TestDocType()
+	{
+		// Do your thing...
+		return CurrentPartialView();
+	}
+}
+```
+
+By inheriting from the `BlockListMvcSurfaceController` base class, you'll also have instant access to the following helper properties / methods.
+
+| Member                                            | Type              | Description |
+|---------------------------------------------------|-------------------|-------------|
+| Model                                             | BlockListItem     | The `BlockListItem` instance of your block's data. |
+| ViewPath                                          | String            | A reference to the currently configured ViewPath |
+| CurrentPartialView(object model = null)           | Method            | Helper method to return you to the default partial view for this cell. If no model is passed in, the standard Model will be passed down. |
+| PartialView(string viewName, object model = null) | Method            | Helper method to return you to an alternative partial view for this cell. If no model is passed in, the standard Model will be passed down. |
+
+---
+
+#### Rendering using BlockListMvc
+To render a `BlockListItem` using BlockListMvc, in stead of doing the usual `@Html.Partial(...)` you need to use the provided helper methods in `Our.Umbraco.BlockListMvc.Helpers`
+
+##### [@Html.BlockListItem(BlockListItem item)](https://github.com/skttl/umbraco-blocklistmvc/blob/master/src/Our.Umbraco.BlockListMvc/Helpers/RenderHelper.cs#L27)
+This one returns an IHtmlString of the rendering. You can also add the list model (BlockListModel), so you can read the context of the block list item (get the index, IsLast, next/previous block etc.), and specify the viewpath with this.
+
+Example:
+
 ```cshtml
 @using Our.Umbraco.BlockListMvc.Helpers
 @foreach (var block in Model.Blocks)
@@ -10,19 +53,24 @@ Still very much work in progress, but to try it out, you render a block list lik
 }
 ```
 
-By default, it will look in `Views/Partials/Blocks/{contentTypeAlias}.cshtml` for views, but this can be customised.
-
-The hijacking part works just like in Dtge with the differiences being, that you have to inherit from `BlockListMvcSurfaceController` and the `Model` is `BlockListItem`. Example:
-```cs
-    public class FeatureSurfaceController : BlockListMvcSurfaceController
-    {
-        public ActionResult Feature()
-        {
-            return CurrentPartialView();
-        }
-    }
+##### [Html.RenderBlockListItem(BlockListItem item)](https://github.com/skttl/umbraco-blocklistmvc/blob/master/src/Our.Umbraco.BlockListMvc/Helpers/RenderHelper.cs#L44)
+The same as the above, this one just doesn't return the HtmlString but adds the rendering to the output.
+
+Example:
+
+```cshtml
+@using Our.Umbraco.BlockListMvc.Helpers
+@foreach (var block in Model.Blocks)
+{
+    Html.RenderBlockListItem(block, Model.Blocks)
+}
 ```
 
-It also adds a new [ViewPage called `BlockListItemViewPage`](https://github.com/skttl/umbraco-blocklistmvc/blob/master/src/Our.Umbraco.BlockListMvc/Mvc/BlockListItemViewPage.cs) which inherits `UmbracoViewPage` and adds a BlockContext property, from which you can get [contextual information](https://github.com/skttl/umbraco-blocklistmvc/blob/master/src/Our.Umbraco.BlockListMvc/Models/BlockListItemContext.cs) like the list the block belongs too, and whether the block is the first/last in the list etc.
+---
+
+#### Individual block views
+By default, BlockListMvc will look for your block item views in Views/Partials/Blocks/{contentTypeAlias}.cshtml, but you can configure the path when rendering with BlockListItem/RenderBlockListItem.
 
+The block view is then created like you are used to.
 
+BlockListMvc comes with its own [ViewPage called `BlockListItemViewPage`](https://github.com/skttl/umbraco-blocklistmvc/blob/master/src/Our.Umbraco.BlockListMvc/Mvc/BlockListItemViewPage.cs) which inherits `UmbracoViewPage` and adds a BlockContext property, from which you can get [contextual information](https://github.com/skttl/umbraco-blocklistmvc/blob/master/src/Our.Umbraco.BlockListMvc/Models/BlockListItemContext.cs) like the list the block belongs too, and whether the block is the first/last in the list etc.