update YAML; update README.md

Author: roei sabag

README.md

@@ -1,2 +1,69 @@
-# gravity-abstraction-logging
+# Gravity Abstraction Logging
 Gravity API, logging abstraction. Allows to create any type of logging output using standard conventions.
+
+# Quick Start (using the existing ```TraceLogger```)
+```csharp
+/* 
+ * if you want the log files to be save in the current directory, do not set "inDirectory" argument.
+ */
+
+var logger = new TraceLogger(applicationName: "myApplication", loggerName: "DataClass", inDirectory: @"C:\Logs");
+logger.Debug(message: "This is a debug message");
+```
+
+# Implement Your Own Message Handling
+```csharp
+/* 
+ * You must inherit Logger class.
+ */
+
+public class HttpLogger : Logger
+{
+    private readonly string baseAddress;
+    private readonly string applicationName;
+    private static readonly HttpClient client = new HttpClient();
+
+    // Will be used to pass values into base class.
+    public HttpLogger(string applicationName, string loggerName)
+       : this(applicationName, loggerName, baseAddress: "http://localhost:5000/")
+    { }
+
+    // Custom constructor to take some HTTP Context.
+    public HttpLogger(string applicationName, string loggerName, string baseAddress)
+       : base(applicationName, loggerName)
+    {
+        this.baseAddress = baseAddress;
+        this.applicationName = applicationName;
+        client.BaseAddress = new Uri(baseAddress);
+    }
+
+    // Creates a child logger with the same application name.
+    public override ILogger CreateChildLogger(string loggerName)
+    {
+        return new HttpLogger(applicationName, loggerName, baseAddress);
+    }
+
+    // Override the message parsing and sending.
+    // At this point the logMessage is already populated and you can change it before sending.
+    public override void OnExecutor(string level, IDictionary<string, object> logMessage)
+    {
+        // setup
+        var requestBody = JsonConvert.SerializeObject(logMessage);
+        var content = new StringContent(content: requestBody, Encoding.UTF8, mediaType: "application/json");
+
+        // some message manipulation
+        logMessage["EndPoint"] = $"{baseAddress}/logging";
+        logMessage["LogType"] = nameof(HttpLogger);
+
+        // send
+        client.PostAsync("/loggingServe", content).GetAwaiter().GetResult();
+    }
+}
+
+/* 
+ * if you want the log files to be sent to "http://localhost:5000", do not set "baseAddress" argument.
+ */
+
+var logger = new HttpLogger(applicationName: "myApplication", loggerName: "DataClass", baseAddress: @"http://loggingserver/");
+logger.Debug(message: "This is a debug message");
+```

azure-pipelines-csharp.yml

@@ -62,4 +62,29 @@ steps:
     command: 'push'
     packagesToPush: '$(Build.ArtifactStagingDirectory)/**/*.nupkg;!$(Build.ArtifactStagingDirectory)/**/*.symbols.nupkg'
     nuGetFeedType: 'external'
-    publishFeedCredentials: 'nuget.org'
+    publishFeedCredentials: 'nuget.org'
+
+- task: PowerShell@2
+  displayName: 'parse build version for GitHub tag'
+  inputs:
+    targetType: 'inline'
+    script: |
+      # setup
+      [regex]$pattern = '(\d+.?)+'
+      $version        = $pattern.Matches('$(Build.BuildNumber)') | foreach-object {$_.Value}      
+      # set value
+      Write-Host "##vso[task.setvariable variable=buildVersion]$version"
+
+- task: GitHubRelease@1
+  displayName: 'create GitHub tag'
+  inputs:
+    gitHubConnection: 'GitHub connection - Gravity API'
+    repositoryName: 'gravity-api/gravity-abstraction-logging'
+    action: 'create'
+    target: '$(Build.SourceVersion)'
+    tagSource: 'userSpecifiedTag'
+    tag: 'v$(buildVersion)'
+    title: 'Production v$(buildVersion)'
+    releaseNotesSource: 'inline'
+    changeLogCompareToRelease: 'lastFullRelease'
+    changeLogType: 'commitBased'

src/csharp/Gravity.Abstraction.Logging/Gravity.Abstraction.Logging.sln

@@ -9,6 +9,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 	ProjectSection(SolutionItems) = preProject
 		..\..\..\azure-pipelines-csharp.yml = ..\..\..\azure-pipelines-csharp.yml
 		..\..\..\azure-settings.runsettings = ..\..\..\azure-settings.runsettings
+		..\..\..\README.md = ..\..\..\README.md
 	EndProjectSection
 EndProject
 Global

src/csharp/Gravity.Abstraction.Logging/Gravity.Abstraction.Logging/Gravity.Abstraction.Logging.csproj

@@ -14,4 +14,8 @@
     <NeutralLanguage>en-US</NeutralLanguage>
   </PropertyGroup>
 
+  <ItemGroup>
+    <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
+  </ItemGroup>
+
 </Project>