diff --git a/.editorconfig b/.editorconfig index ed9d022..19e73ae 100644 --- a/.editorconfig +++ b/.editorconfig @@ -5,7 +5,7 @@ indent_style = tab indent_size = 4 tab_width = 4 end_of_line = lf -insert_final_newline = false +insert_final_newline = true trim_trailing_whitespace = true max_line_length = 120 diff --git a/src/process.dummy.app/Geekeey.Process.Dummy.App.csproj b/src/process.dummy.app/Geekeey.Process.Dummy.App.csproj index a8234c4..f9df4fa 100644 --- a/src/process.dummy.app/Geekeey.Process.Dummy.App.csproj +++ b/src/process.dummy.app/Geekeey.Process.Dummy.App.csproj @@ -13,4 +13,5 @@ - + + \ No newline at end of file diff --git a/src/process/Geekeey.Process.csproj b/src/process/Geekeey.Process.csproj index ef1e89d..3866467 100644 --- a/src/process/Geekeey.Process.csproj +++ b/src/process/Geekeey.Process.csproj @@ -13,7 +13,7 @@ - + diff --git a/src/process/package-readme.md b/src/process/package-readme.md index dbb26d9..9172486 100644 --- a/src/process/package-readme.md +++ b/src/process/package-readme.md @@ -1,9 +1,29 @@ Process is a library for interacting with external command-line interfaces. It provides a convenient model for launching processes, redirecting input and output streams, awaiting completion, handling cancellation, and more. -## Usage +## Features -### Execute a command and capturing its output: +- **Input and Output redirection:** flexible piping model, that allows to redirect the process's streams. +- **Immutability:** The `Command` object is immutable, ensuring thread safely and allowing sharing of a base + configuration. + +## Getting Started + +### Install the NuGet package: + +```shell +dotnet add package Geekeey.Request +``` + +You may need to add our NuGet feed to your nuget.config this can be done by running the following command: + +```shell +dotnet nuget add source -n geekeey https://code.geekeey.de/api/packages/geekeey/nuget/index.json +``` + +### Usage + +#### Execute a command and capturing its output: ```csharp public static async Task Main() @@ -16,7 +36,7 @@ public static async Task Main() } ``` -### Execute a command and redirect its output to another command: +#### Execute a command and redirect its output to another command: ```csharp public static Task Main() @@ -27,7 +47,7 @@ public static Task Main() } ``` -### Execute a command with cancellation support: +#### Execute a command with cancellation support: ```csharp public static async Task Main() @@ -48,4 +68,4 @@ public static async Task Main() var result = await app; return 0; } -``` \ No newline at end of file +```