readme

Author: AnthonyCarl

README.md

@@ -2,3 +2,97 @@ ServiceStack.Text.EnumMemberSerializer
 ======================================
 
 Extension for ServiceStack.Text to allow using EnumMember attributes to serialize and deserialize enumerations.
+
+Example
+======================================
+#Example Configuration
+
+Configure Explicit Enumerations
+```c#
+new EnumSerializerConfigurator()
+  .WithEnumTypes(new Type[] { typeof(ReturnPolicy) })
+  .Configure();
+```
+
+Configure all enumerations in the ExampleCode namespce for all assemblies in my current app domain:
+```c#
+new EnumSerializerConfigurator()
+  .WithAssemblies(AppDomain.CurrentDomain.GetAssemblies())
+  .WithNamespaceFilter(ns => ns.StartsWith("ExampleCode"))
+  .Configure();
+```
+
+#Example Enumeration:
+```c#
+using System.Runtime.Serialization;
+
+namespace ExampleCode
+{
+  public enum ReturnPolicy
+  {
+    NotSet = 0,
+    [EnumMember(Value = @"90 Days w/Receipt")]
+    _90DayswReceipt = 1,
+    [EnumMember(Value = @"15% Restocking Fee")]
+    _15RestockingFee = 2,
+    [EnumMember(Value = @"Exchange Only")]
+    ExchangeOnly = 3,
+    [EnumMember(Value = @"As-Is")]
+    AsIs = 4,
+    ...
+  }
+}
+```
+
+#Example Dto
+```c#
+namespace ExampleCode
+{
+  public class ProductInfo
+  {
+    public string ProductName { get; set; }
+    public ReturnPolicy ReturnPolicy { get; set; }
+    ...
+  }
+}
+```
+
+#Url Examples
+
+These will search for all product returnable within 90 days with receipt (all of these will work):
+```
+http://myhost/products?returnpolicy=90%20Days%20w%2FReceipt
+http://myhost/products?returnpolicy=90%20DaYS%20w%2FReceIPt
+http://myhost/products?returnpolicy=_90DayswReceipt
+http://myhost/products?returnpolicy=1
+```
+
+#Example Response
+
+With ServiceStack.Text.EnumMemberSerializer you get this:
+```JSON
+[
+   {
+     "ProductName": "Hammer",
+     "ReturnPolicy": "90 Days w/Receipt"
+   },
+   {
+     "ProductName": "Chisel",
+     "ReturnPolicy": "90 Days w/Receipt"
+   }
+]
+```
+
+Without ServiceStack.Text.EnumMemberSerializer
+```JSON
+[
+   {
+     "ProductName": "Hammer",
+     "ReturnPolicy": "_90DayswReceipt"
+   },
+   {
+     "ProductName": "Chisel",
+     "ReturnPolicy": "_90DayswReceipt"
+   }
+]
+```