Skip to content

Commit 71973bd

Browse files
authored
Update README.md
1 parent 45925bf commit 71973bd

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,29 @@
1-
## <table style="overflow:hideen"><tr style="border:none"><td style="border:none"> <img src="https://raw.githubusercontent.com/navtech-io/Simpleflow/develop/src/Simpleflow/PackageIcon.png" style="width:60px"> </td> <td style="border:none;">&nbsp;&nbsp;Simpleflow </td></tr></table>
21

2+
# Simpleflow
33

44
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.
55

66

77
[![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)
88

9-
**Simpleflow Script**
9+
<img src="https://raw.githubusercontent.com/navtech-io/Simpleflow/develop/src/Simpleflow/PackageIcon.png" >
10+
11+
## Get Started
12+
13+
Install package via Nuget. Using the NuGet package manager console within Visual Studio run the following command:
14+
15+
```powershell
16+
Install-Package Simpleflow
17+
```
18+
19+
**Try following Simpleflow script:**
1020

1121
```csharp
1222

1323
// Simpleflow Script
1424
var flowScript =
1525
@"
16-
let text = ""Hello, विश्वम्‌""
26+
let text = ""Hello, World! 🌄""
1727
let today = $GetCurrentDateTime ( timezone: ""Eastern Standard Time"" )
1828
1929
/* comment: check condition */
@@ -25,7 +35,7 @@ var flowScript =
2535
";
2636

2737
// Execute Script
28-
FlowOutput result = SimpleflowEngine.Run(flowScript, new {UniversalId = 2, New=true, Verified=false} );
38+
Simpleflow.FlowOutput result = Simpleflow.SimpleflowEngine.Run(flowScript, new {UniversalId = 2, New=true, Verified=false} );
2939

3040
// Access result
3141
Console.WriteLine(result.Messages[0]);
@@ -35,7 +45,7 @@ Console.WriteLine(result.Output["today"]);
3545
**Output**
3646

3747
```
38-
Hello, विश्वम्‌
48+
Hello, World! 🌄
3949
<current system date and time>
4050
```
4151
Please see [this](#examples) example with most of the simpleflow script features.
@@ -186,9 +196,10 @@ $<function_name>(param_name1: value1, param_name2: value2, ...)
186196
let d2 = $Date(m: 10, d:25, y: 2022 )
187197
let t1 = $Date(m: 10, d:25, y: 2022, h:13, mn:30 )
188198
```
189-
* $\color{#4686f2}{\$GetCurrentDate()}$
190-
* $\color{#4686f2}{\$GetCurrentTime()}$
191-
* $\color{#4686f2}{\$GetCurrentDateTime(timeZone: "")}$
199+
200+
* $\color{#4686f2}{\$GetCurrentDate()}$
201+
* $\color{#4686f2}{\$GetCurrentTime()}$
202+
* $\color{#4686f2}{\$GetCurrentDateTime(timeZone: "")}$
192203

193204
Check available list of time zones here: <br>
194205
Windows: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11#time-zones <br>

0 commit comments

Comments
 (0)