From 72b07e091e1aa63a8b22339571e265b65aa623a3 Mon Sep 17 00:00:00 2001
From: Iain Hecker <github@iain.nl>
Date: Tue, 4 Nov 2008 11:30:59 +0100
Subject: [PATCH] Readme love

---
 README.textile | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/README.textile b/README.textile
index e4536bb..ab2e0bd 100644
--- a/README.textile
+++ b/README.textile
@@ -1,4 +1,31 @@
 h1. ModelBasedHtml
 
+This plugin enables the binding of other html elements to models, just like form_for.
+
+An example says it all:
+
+  <% definition_list_for @user do |dl| %>
+
+    <%= dl.dt :login %>
+    <%= dl.dd :login %>
+
+    <%= dl.dt :email %>
+    <%= dl.dd :email do |mail_address| %>
+      <%= mail_to mail_address %>
+    <% end %>
+
+  <% end %>
+    
+The dt method will automatically display the human_attribute_name of this 
+attribute, the dd will automatically show the value of this attribute. You can 
+pass a block to these methods to play with the value even more, like making it 
+a link. Because these values may be harmful, a dd_h method is also available,
+sanitizing html automatically. You can limit it to one line, using dt_and_dd or dt_and_dd_h.
+
+A table_for is also under development.
+
+Please note that this plugin is still very much under development. Use at your own risk.
+
+
 
 Copyright (c) 2008 Iain Hecker, released under the MIT license