Merge pull request #21 from vtex/documentation/create_project_usage_documentation

Create project README

Author: Caldas

README.md

@@ -1,2 +1,141 @@
 # SplunkLogger
-C# .Net Core 2 Splunk ILogger Compatible Implementation
+This is a C# .Net Core 2 Splunk ILogger implementation developed at **VTEX** to send log to **Splunk**
+
+| Package Name                   | Release |
+|--------------------------------|-----------------|
+| `SplunkLogger`         | [![NuGet](https://img.shields.io/nuget/v/SplunkLogger.svg)](https://www.nuget.org/packages/SplunkLogger/) |
+
+It was developed to be integrated to .Net Core 2 logging abstractions.
+
+### Features
+
+* ILoggerProviders (*SplunkHECJsonLoggerProvider*, *SplunkHECRawLoggerProvider*, *SplunkTcpLoggerProvider* and *SplunkUdpLoggerProvider*)
+* ILoggers (**HEC** (*Raw* and *Json*) and **Socket** (*TCP* and *UDP*)
+* Custom Configurations
+* Batch Manager class (Improve **Splunk** *HEC* performance sending data as batch)
+
+## Usage
+
+After add *SplunkLogger* nuget library
+```powershell
+PM> Install-Package SplunkLogger
+```
+
+You should initialize a new *SplunkLoggerConfiguration* and the logger provider at **Configure** method at **Startup** class:
+
+```csharp
+static readonly ILoggerFormatter formatter = null;
+
+public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
+{
+    var splunkConfiguration = new SplunkLoggerConfiguration()
+    {
+        HecConfiguration = new HECConfiguration()
+        {
+            SplunkCollectorUrl = "https://localhost:8088/services/collector",
+            Token = "753c5a9c-fb59-4da0-9064-947f99dc20ba"
+        }
+    };
+    loggerFactory.AddHECRawSplunkLogger(splunkConfiguration, formatter);
+    app.UseMvc();
+}
+```
+
+In this case above we added a **Splunk** *HEC Raw* logger without any custom formmater as log provider.
+
+Now in your controller you can log normally, for instance:
+
+```csharp
+[Route("api/[controller]")]
+public class ValuesController : Controller
+{
+    readonly ILogger logger;
+
+    public ValuesController(ILoggerFactory loggerFactory)
+    {
+        logger = loggerFactory.CreateLogger<ValuesController>();
+    }
+
+    // GET api/values
+    [HttpGet]
+    public IEnumerable<string> Get()
+    {
+        logger.LogCritical(new EventId(-1, "Values Controller"), new NotImplementedException(), "Error on GET api/values route");
+        return new string[] { "value1", "value2" };
+    }
+}
+```
+
+-------------------------------------------
+
+# VTEXSplunkLogger
+For us at **VTEX** we need more customized log entries at Splunk and also we need easier ways to call for log registration during the code and for that we created this *VTEXSplunkLogger* library.
+
+This project contains all **VTEX** extra classes designed to facilitate to log registration and also, all classes to customize .Net Core 2 log abstraction to a customized log entry at **Splunk**
+
+| Package Name                   | Release |
+|--------------------------------|-----------------|
+| `VTEXSplunkLogger` | [![MyGet](https://img.shields.io/myget/vtexlab/v/VTEXSplunkLogger.svg)](https://www.myget.org/feed/vtexlab/package/nuget/VTEXSplunkLogger) |
+
+### Features
+
+* ILoggerExtensions (*Allow easy log creation*)
+* LoggerFactoryExtensions (*Simplify loggerFactory add provider method call*)
+* VTEXSplunkLoggerFormatter (*Custom `ILoggerFormatter` responsable for create VTEX custom text to Splunk*)
+
+
+## Usage
+
+After add *VTEXSplunkLogger* nuget library
+```powershell
+PM> Install-Package VTEXSplunkLogger -Version 1.0.0 -Source https://www.myget.org/F/vtexlab/api/v3/index.json
+```
+
+You should initialize a new *SplunkLoggerConfiguration* and the logger provider at **Configure** method at **Startup** class:
+
+```csharp
+static readonly ILoggerFormatter formatter = new VTEXSplunkLoggerFormatter();
+
+public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
+{
+    var splunkConfiguration = new SplunkLoggerConfiguration()
+    {
+        HecConfiguration = new HECConfiguration()
+        {
+            SplunkCollectorUrl = "https://localhost:8088/services/collector",
+            Token = "753c5a9c-fb59-4da0-9064-947f99dc20ba"
+        }
+    };
+    loggerFactory.AddHECRawSplunkLogger(splunkConfiguration, formatter);
+    app.UseMvc();
+}
+```
+
+```csharp
+using Vtex;
+//other usings ..
+
+[Route("api/[controller]")]
+public class ValuesController : Controller
+{
+    readonly ILogger logger;
+
+    public ValuesController(ILoggerFactory loggerFactory)
+    {
+        logger = loggerFactory.CreateLogger<ValuesController>();
+    }
+
+    // GET api/values
+    [HttpGet]
+    public IEnumerable<string> Get()
+    {
+        logger.DefineVTEXLog(LogLevel.Critical, 
+                             "Values Controller", 
+                             "api/values", 
+                             string.Empty, 
+                             new NotImplementedException(), 
+                             new Tuple<string, string>("method", "GET"));
+        return new string[] { "value1", "value2" };
+    }
+}
+```