From df5d18412c0229fe7e99e1a89eca9b638970e4f5 Mon Sep 17 00:00:00 2001
From: Daniel Wiklund <daniel@happyrabbit.com>
Date: Tue, 15 Jul 2014 10:28:24 +0800
Subject: [PATCH] Improved Shared Form Model Methods documentation

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index 31c878b..cfa2b7f 100644
--- a/README.md
+++ b/README.md
@@ -63,6 +63,22 @@ You can generate a default model like this by running:
 
 TODO: Add generator
 
+This will add an `ApplicationTransForm` model...
+
+    # app/trans_forms/application_trans_form.rb
+    class ApplicationTransForm < TransForms::FormBase
+      # ...
+    end
+
+... that you can use in you Form Models:
+
+    class PostForm < ApplicationTransForm
+      # ...
+    end
+
+Note that by having a model with the exact name `ApplicationTransForm`, the generator
+for new Form Models will by default inherit from that model instead of the `TransForm::FormBase`
+
 ## Contributing
 
 1. Fork it ( https://github.com/dannemanne/trans_forms/fork )