Skip to content

Commit

Permalink
Amended readme and uploaded the library to nuget
Browse files Browse the repository at this point in the history
  • Loading branch information
code-dispenser committed Jun 4, 2024
1 parent afe3a3e commit 9ff7a8c
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 5 deletions.
19 changes: 15 additions & 4 deletions ReadMe.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
[![.NET](https://github.com/code-dispenser/Flow/actions/workflows/buildandtest.yml/badge.svg?branch=main)](https://github.com/code-dispenser/Flow/actions/workflows/buildandtest.yml) [![Coverage Status](https://coveralls.io/repos/github/code-dispenser/Flow/badge.svg?branch=main)](https://coveralls.io/github/code-dispenser/Flow?branch=main)
<!-- [![Nuget download][download-image]][download-url]
[![Nuget download][download-image]][download-url]

[download-image]: https://img.shields.io/nuget/dt/Conditionals.Core
[download-url]: https://www.nuget.org/packages/Conditionals.Core
[download-image]: https://img.shields.io/nuget/dt/Flow.Core
[download-url]: https://www.nuget.org/packages/Flow.Core

-->
<h1>
<img src="https://raw.github.com/code-dispenser/Flow/main/Assets/icon-64.png" align="center" alt="flow icon" /> Flow
</h1>
Expand All @@ -26,6 +25,18 @@ processes to work as intended.

The demo project included in the repository's [source code](https://github.com/code-dispenser/Flow) shows examples of custom classes being attributed to ensure serialization/deserialization with either protobuf-net or JSON.

**Note:** For flows that do not require a return value you can use the **None** type available within the library.
```C#
using Flow.Core.Areas.Returns;
using Flow.Core.Common.Models;

Flow<None> successFlow = Flow<None>.Success();
/*
*or using the implicit operator
*/
Flow<None> successFlow = None.Value;
```

## Installation

Download and install the latest version of the [Flow.Core](https://www.nuget.org/packages/Flow.Core) package from [nuget.org](https://www.nuget.org/) using your preferred client tool.
Expand Down
2 changes: 1 addition & 1 deletion Source/Flow.Core/Flow.Core.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<Version>1.0.0</Version>
<Authors>Paul Kent</Authors>
<Description>Flow is a lightweight monadic result type that encapsulates the outcome of an operation, returning either a success or failure value. Designed for seamless integration, Flow and its associated failure classes are attributed for both gRPC code-first and System.Text.Json serialization.</Description>
<PackageTags>operation result; result; monad; functional; method chaining</PackageTags>
<PackageTags>operation result; monad; functional; method chaining; fluent</PackageTags>
<GenerateDocumentationFile>False</GenerateDocumentationFile>
<GeneratePackageOnBuild>False</GeneratePackageOnBuild>
<PackageReadmeFile>ReadMe.md</PackageReadmeFile>
Expand Down

0 comments on commit 9ff7a8c

Please sign in to comment.