Provide brief doc in README.md

README.md

@@ -1,3 +1,141 @@
-# MappingGenerator
-
+# Mapping Generator
 [![Build status](https://ci.appveyor.com/api/projects/status/v73nnoo09cc8kkmo/branch/master?svg=true)](https://ci.appveyor.com/project/cezarypiatek/mappinggenerator/branch/master)
+
+"AutoMapper" like, Roslyn based, code fix provider that allows to generate mapping code in design time.
+
+You can download it as Visual Studio Extension from [Releases](https://github.com/cezarypiatek/MappingGenerator/releases) page.
+
+## Main features
+
+### Generate mapping method body
+
+#### Pure mapping method
+Non-void method that takes single parameter
+
+```csharp
+public UserDTO Map(UserEntity entity)
+{
+
+}
+```
+
+![Generating pure mapping method implementation](doc/pure_mapping_method.gif)
+
+
+#### Updating method
+Void method that takes two parameters
+```csharp
+public void Update(UserDTO source, UserEntity target)
+{
+
+}
+```
+![Generating update method implementation](doc/update_method.gif)
+
+#### Mapping Constructor
+Constructor method that takes single parameter
+
+```csharp
+public UserDTO(UserEntity user)
+{
+
+}
+```
+
+![Generating mapping constructor implementation](doc/mapping_constructor.gif)
+
+#### Updating member method
+Void member method that takes single parameter
+```csharp
+public void UpdateWith(UserEntity en)
+{
+
+}
+```
+
+![Generating update member method imeplementation](doc/update_member_method.gif)
+
+### Generate inline code for fixing Compiler Errors: 
+[CS0029](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/cs0029) Cannot implicitly convert type 'type' to 'type'
+
+![cs0029](/doc/cs0029.jpg)
+
+[CS0266](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/cs0266) Cannot implicitly convert type 'type1' to 'type2'. An explicit conversion exists (are you missing a cast?)
+
+![cs0266](/doc/cs0266.jpg)
+
+## Mapping features
+- Mapping Property-To-Property
+  ```csharp
+  target.FirstName = source.FirstName;
+  target.LastName = source.LastName;
+  ```
+- Mapping Method Call-To-Property
+  ```csharp
+  target.Total = source.GetTotal()
+  ```
+- Flattening with sub-property
+  ```csharp
+  target.UnitId = source.Unit.Id
+  ```
+- Mapping complex property
+  ```csharp
+  var targetMainAddress = new AddressDTO();
+  targetMainAddress.BuildingNo = source.MainAddress.BuildingNo;
+  targetMainAddress.City = source.MainAddress.City;
+  targetMainAddress.FlatNo = source.MainAddress.FlatNo;
+  targetMainAddress.Street = source.MainAddress.Street;
+  targetMainAddress.ZipCode = source.MainAddress.ZipCode;
+  target.MainAddress = targetMainAddress;
+  ```
+- Mapping collections
+  ```csharp
+  target.Addresses = source.Addresses.Select(addressEntity =>
+  {
+      var addressDTO = new AddressDTO();
+      addressDTO.BuildingNo = addressEntity.BuildingNo;
+      addressDTO.City = addressEntity.City;
+      addressDTO.FlatNo = addressEntity.FlatNo;
+      addressDTO.Street = addressEntity.Street;
+      addressDTO.ZipCode = addressEntity.ZipCode;
+      return addressDTO;
+  }).ToList().AsReadOnly();
+  ```
+- Unwrapping wrappers 
+  ```csharp
+  customerEntity.Kind = cutomerDTO.Kind.Selected;
+  ```
+
+  ```csharp
+    public enum CustomerKind
+    {
+        Regular,
+        Premium
+    }
+
+    public class Dropdown<T>
+    {
+        public List<T> AllOptions { get; set; }
+
+        public T Selected { get; set; }
+    }
+
+    public class CustomerDTO
+    {
+        public string Name { get; set; }
+        public Dropdown<CustomerKind> Kind { get; set; }
+    }
+
+    public class UserEntity
+    {
+        public string Name { get; set; }
+        public CustomerKind Kind { get; set; }
+    }
+  ```
+- Using existing mapping constructor
+  ```csharp
+  target.MainAddress = new AddressDTO(source.MainAddress);
+  ```
+
+
+