chore: update project for consistency #2
1 changed files with 25 additions and 5 deletions
chore: update package-readme.md
commit
dc607c2653
|
|
@ -1,9 +1,29 @@
|
||||||
Process is a library for interacting with external command-line interfaces. It provides a convenient model for launching
|
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.
|
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
|
```csharp
|
||||||
public static async Task<int> Main()
|
public static async Task<int> Main()
|
||||||
|
|
@ -16,7 +36,7 @@ public static async Task<int> Main()
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Execute a command and redirect its output to another command:
|
#### Execute a command and redirect its output to another command:
|
||||||
|
|
||||||
```csharp
|
```csharp
|
||||||
public static Task<int> Main()
|
public static Task<int> Main()
|
||||||
|
|
@ -27,7 +47,7 @@ public static Task<int> Main()
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Execute a command with cancellation support:
|
#### Execute a command with cancellation support:
|
||||||
|
|
||||||
```csharp
|
```csharp
|
||||||
public static async Task<int> Main()
|
public static async Task<int> Main()
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue