Skip to content

Commit 98d3990

Browse files
committed
Update README file #62
1 parent 0eea851 commit 98d3990

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

README.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,24 @@
1-
# FlowSynx.Client SDK for C#
1+
<div align="center">
2+
<h1>C# FlowSynx.Client</h1>
3+
<p><i>C# SDK for FlowSynx</i></p>
24

3-
[![dotnet][dotnet-budge]][dotnet-url] [![License: MIT][mit-badge]][mit-url] [![Build Status][actions-badge]][actions-url] [![FOSSA Status][fossa-badge]][fossa-url]
5+
[![dotnet][dotnet-budge]][dotnet-url] [![License: MIT][mit-badge]][mit-url] [![Build Status][actions-badge]][actions-url] [![FOSSA Status][fossa-badge]][fossa-url]
46

5-
[mit-badge]: https://img.shields.io/github/license/flowsynx/csharp-sdk?style=flat&label=License&logo=github
6-
[mit-url]: https://github.com/flowsynx/csharp-sdk/blob/master/LICENSE
7-
[actions-badge]: https://github.com/flowsynx/csharp-sdk/actions/workflows/sdk_build.yml/badge.svg?branch=master
8-
[actions-url]: https://github.com/flowsynx/csharp-sdk/actions?workflow=build-nuget
9-
[fossa-badge]: https://app.fossa.com/api/projects/git%2Bgithub.com%2Fflowsynx%2Fcsharp-sdk.svg?type=shield&issueType=license
10-
[fossa-url]: https://app.fossa.com/projects/git%2Bgithub.com%2Fflowsynx%2Fcsharp-sdk?ref=badge_shield&issueType=license
11-
[dotnet-budge]: https://img.shields.io/badge/.NET-9.0-blue
12-
[dotnet-url]: https://dotnet.microsoft.com/en-us/download/dotnet/9.0
7+
[mit-badge]: https://img.shields.io/github/license/flowsynx/csharp-sdk?style=flat&label=License&logo=github
8+
[mit-url]: https://github.com/flowsynx/csharp-sdk/blob/master/LICENSE
9+
[actions-badge]: https://github.com/flowsynx/csharp-sdk/actions/workflows/sdk_build.yml/badge.svg?branch=master
10+
[actions-url]: https://github.com/flowsynx/csharp-sdk/actions?workflow=build-nuget
11+
[fossa-badge]: https://app.fossa.com/api/projects/git%2Bgithub.com%2Fflowsynx%2Fcsharp-sdk.svg?type=shield&issueType=license
12+
[fossa-url]: https://app.fossa.com/projects/git%2Bgithub.com%2Fflowsynx%2Fcsharp-sdk?ref=badge_shield&issueType=license
13+
[dotnet-budge]: https://img.shields.io/badge/.NET-9.0-blue
14+
[dotnet-url]: https://dotnet.microsoft.com/en-us/download/dotnet/9.0
15+
</div>
1316

1417
**FlowSynx.Client** is a modern, extensible C# SDK designed to integrate seamlessly with
1518
the [FlowSynx Workflow Automation Engine](https://flowsynx.io), providing a streamlined way to interact with its powerful REST API.
1619
This SDK enables developers to manage workflows, plugins, executions, configurations, and more through a simple, fluent .NET API.
1720

18-
## 🚀 Features
21+
## Features
1922
- Connect securely to FlowSynx via REST
2023
- Manage workflows and plugin configurations
2124
- Trigger and monitor workflow executions
@@ -24,14 +27,14 @@ This SDK enables developers to manage workflows, plugins, executions, configurat
2427
- Lightweight, dependency-free architecture
2528
- Built for .NET 9.0 with extensibility and clean architecture in mind
2629

27-
## 📦 Installation
30+
## Installation
2831
You can install the SDK via [NuGet](https://www.nuget.org/packages/FlowSynx.Client):
2932

3033
```
3134
dotnet add package FlowSynx.Client
3235
```
3336

34-
## 🧩 Usage
37+
## Usage
3538
1. Configure the Client
3639

3740
Make sure the blow package are added to you project:
@@ -74,6 +77,6 @@ var workflowRequest = new ExecuteWorkflowRequest { WorkflowId = workflowId };
7477
var result = await _flowSynxClient.Workflows.ExecuteAsync(workflowRequest, cancellationToken);
7578
```
7679

77-
## Requirements
80+
## Requirements
7881
- .NET 9.0 or later
7982
- Compatible with Windows, Linux, macOS

0 commit comments

Comments
 (0)