Merge pull request #3 from navtech-io/develop

Develop

Author: rajeshjn

README.md

@@ -1,18 +1,30 @@
-## Simpleflow
+
+# Simpleflow
 
 Simpleflow is a lightweight dynamic rule engine to build workflow with intuitive script concepts. Simpleflow allows access to the process objects or methods in script securely. Methods can be registered as activities with Simpleflow engine, which is extensible to enrich or monitor the execution flow. Simpleflow is secure and efficient to run dynamic rules and workflow. 
 
 
 [![NuGet version (Simpleflow)](https://img.shields.io/nuget/vpre/Simpleflow?style=for-the-badge)](https://www.nuget.org/packages/Simpleflow/) [![Github Workflow (Simpleflow)](https://img.shields.io/github/workflow/status/navtech-io/simpleflow/.NET?style=for-the-badge)](https://github.com/navtech-io/Simpleflow/actions)
 
-**Simpleflow Script**
+<img src="https://raw.githubusercontent.com/navtech-io/Simpleflow/develop/src/Simpleflow/PackageIcon.png" >
+
+## Get Started
+
+Install package via Nuget. Using the NuGet package manager console within Visual Studio run the following command:
+
+```powershell
+Install-Package Simpleflow	
+```
+
+**Try following Simpleflow script:**
 
 ```csharp
+using Simpleflow;
 
 // Simpleflow Script
 var flowScript = 
 @" 
-    let text  = ""Hello, विश्वम्‌""
+    let text  = ""Hello, World! 🌄""
     let today = $GetCurrentDateTime ( timezone: ""Eastern Standard Time"" )
 
     /* comment: check condition  */
@@ -34,7 +46,7 @@ Console.WriteLine(result.Output["today"]);
 **Output**
 
 ```
-Hello, विश्वम्‌
+Hello, World! 🌄
 <current system date and time>
 ```
 Please see [this](#examples) example with most of the simpleflow script features.
@@ -185,9 +197,10 @@ $<function_name>(param_name1: value1, param_name2: value2, ...)
     let d2 = $Date(m: 10, d:25, y: 2022 )
     let t1 = $Date(m: 10, d:25, y: 2022, h:13, mn:30 )
     ```        
-* $\color{#4686f2}{\$GetCurrentDate()}$
-* $\color{#4686f2}{\$GetCurrentTime()}$
-* $\color{#4686f2}{\$GetCurrentDateTime(timeZone: "")}$
+
+* $\color{#4686f2}{\$GetCurrentDate()}$ 
+* $\color{#4686f2}{\$GetCurrentTime()}$ 
+* $\color{#4686f2}{\$GetCurrentDateTime(timeZone: "")}$ 
 
     Check available list of time zones here: <br>
     Windows: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11#time-zones <br>

build/Build.cs

@@ -112,8 +112,9 @@ class Build : NukeBuild
                 .SetCopyright("navtech.io")
                 .SetPackageProjectUrl("https://github.com/navtech-io/Simpleflow")
                 .AddProperty("PackageLicenseExpression", "Apache-2.0")
+                .AddProperty("PackageIcon", @"PackageIcon.png")
                 .SetIncludeSymbols(true)
-                .SetVersion("0.1.0-beta04" /*NuGetVersionCustom*/)
+                .SetVersion("0.1.0-beta05" /*NuGetVersionCustom*/)
                 .SetDescription("Lightweight rule engine")
                 .SetPackageTags("Simpleflow.NET Workflow RuleEngine DynamicExpressionEvaluator")
                 .SetNoDependencies(true)

src/Simpleflow/PackageIcon.png

@@ -2,10 +2,11 @@
 
   <PropertyGroup>
     <TargetFrameworks>netcoreapp3.1;net5.0;net6.0</TargetFrameworks>
+    <PackageIcon>PackageIcon.png</PackageIcon>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
-    <DocumentationFile>C:\Navtech\Opensource\Simpleflow\src\Simpleflow\Simpleflow.xml</DocumentationFile>
+    <DocumentationFile>Simpleflow.xml</DocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>
@@ -30,11 +31,15 @@
   </ItemGroup>
 
   <ItemGroup>
-    <EditorConfigFiles Remove="C:\Navtech\Opensource\Simpleflow\src\Simpleflow\.editorconfig" />
+    <EditorConfigFiles Remove=".editorconfig" />
   </ItemGroup>
 
   <ItemGroup>
-    <None Include="C:\Navtech\Opensource\Simpleflow\src\Simpleflow\.editorconfig" />
+    <None Include=".editorconfig" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <None Include="PackageIcon.png" Pack="true" PackagePath="\" />
   </ItemGroup>
 
 </Project>