Merge branch 'master' of https://github.com/HenkMollema/Dommel.git

README.md

@@ -2,13 +2,7 @@ Dommel
 ======
 [![Build status](https://ci.appveyor.com/api/projects/status/kynsbfu97f9s5bj7)](https://ci.appveyor.com/project/HenkMollema/dommel)
 
-Dommel provides a convenient API for CRUD operations using extension methods on the `IDbConnection` interface. [Dapper](https://github.com/StackExchange/dapper-dot-net) is used for query execution and object mapping. The functionality is basically the same as [Dapper.Contrib](https://github.com/StackExchange/dapper-dot-net/tree/master/Dapper.Contrib) (and Dapper.Rainbow) but since it's not updated any time lately and it has some shortcomings, I decided to create a similar tool.
-
-One of the things I got stuck with using Dapper.Contrib, was mapping of column names. For Dapper, I solved this by creating [Dapper.FluentMap](https://github.com/HenkMollema/Dapper-FluentMap), but this doesn't work for Dapper.Contrib.
-
-### To-do
-* Improve documentation in readme.
-* Add functionality to customize column name mapping of POCO properties.
+Dommel provides a convenient API for CRUD operations using extension methods on the `IDbConnection` interface. [Dapper](https://github.com/StackExchange/dapper-dot-net) is used for query execution and object mapping. The functionality is basically the same as [Dapper.Contrib](https://github.com/StackExchange/dapper-dot-net/tree/master/Dapper.Contrib) (and Dapper.Rainbow) but since it has not been updated any time lately and it has some shortcomings, Dommel was born.
 
 ### Donwload
 NuGet package comming soon.
@@ -55,8 +49,61 @@ using (IDbConnection con = new SqlConnection())
 }
 ```
 
-### Extensibility points
-Currently the API exists of 2 extension points:
+### Extensibility
 ##### `ITableNameResolver`
+Implement this interface if you want to customize the resolving of table names when building SQL queries.
+```csharp
+public class CustomTableNameResolver : Dommel.ITableNameResolver
+{
+    public string ResolveTableName(Type type)
+    {
+        // Every table has prefix 'tbl'.
+        return "tbl" + type.Name;
+    }
+}
+```
+
+Use the `SetTableNameResolver()` method to register the custom implementation:
+```csharp
+Dommel.SetTableNameResolver(new CustomTableNameResolver());
+```
 
 ##### `IKeyPropertyResolver`
+Implement this interface if you want to customize the resolving of the key property of an entity. By default, Dommel will search for a property with the `[Key]` attribute, or a column with the name 'Id'.
+
+If you, for example, have the naming convention of `{TypeName}Id` for key properties, you would implement the `IKeyPropertyResolver` like this:
+```csharp
+public class CustomKeyPropertyResolver : Dommel.IKeyPropertyResolver
+{
+    public PropertyInfo ResolveKeyProperty(Type type)
+    {
+        return type.GetProperties().Single(p => p.Name == string.Format("{0}Id", type.Name));
+    }
+}
+```
+
+Use the `SetKeyPropertyResolver()` method to register the custom implementation:
+```csharp
+Dommel.SetKeyPropertyResolver(new CustomKeyPropertyResolver());
+```
+
+##### `IColumnNameResolver`
+Implement this interface if you want to customize the resolving of column names for when building SQL queries. This is useful when your naming conventions for database columns are different than your POCO properties.
+
+```csharp
+public class CustomColumnNameResolver : Dommel.IColumnNameResolver
+{
+    public string ResolveColumnName(PropertyInfo propertyInfo)
+    {
+        // Every column has prefix 'fld' and is uppercase.
+        return "fld" + propertyInfo.Name.ToUpper();
+    }
+}
+```
+
+Use the `SetColumnNameResolver()` method to register the custom implementation:
+```csharp
+Dommel.SetColumnNameResolver(new CustomColumnNameResolver());
+```
+
+I am working on a version of [Dapper.FluentMap](https://github.com/HenkMollema/Dapper-FluentMap) which implements the `IColumnNameResolver` and uses the configured mapping.