Skip to content

Commit

Permalink
Update README with new package name (#12)
Browse files Browse the repository at this point in the history
  • Loading branch information
eneko authored Jun 26, 2020
1 parent bef83ab commit bedc557
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# System
# ProcessRunner

![System](/system.png)
![ProcessRunner](/processrunner.png)

![Release](https://img.shields.io/github/release/eneko/System.svg)
![Swift 5.0](https://img.shields.io/badge/Swift-5.0-orange.svg)
Expand Down Expand Up @@ -29,15 +29,15 @@ scripting (Rakefile, Fastlane, Danger, etc), you will feel like home.
### 💻 Automatically redirect output to stdout

```swift
import System
import ProcessRunner

try system(command: "echo hello world") // prints "hello world" to stdout
```

### ✇ Capture process output

```swift
import System
import ProcessRunner

let output = try system(command: "echo hello world", captureOutput: true).standardOutput
print(output) // prints "hello world"
Expand All @@ -46,35 +46,35 @@ print(output) // prints "hello world"
### ✔️ Check if process terminated gracefully

```swift
import System
import ProcessRunner

print(try system(command: "echo hello world").success) // prints "true"
```

### |> Easily execute Shell commands with pipes and redirects

```swift
import System
import ProcessRunner

try system(shell: "echo hello cat > cat && cat cat | awk '{print $2}'") // prints "cat" to stdout
```

## Installation

Add `System` to your `Package.swift`:
Add `ProcessRunner` to your `Package.swift`:

```swift
import PackageDescription

let package = Package(
name: "YourPackage",
dependencies: [
.package(url: "[email protected]:eneko/System.git", from: "1.0.0"),
.package(url: "[email protected]:eneko/ProcessRunner.git", from: "1.0.0"),
],
targets: [
.target(
name: "YourTarget",
dependencies: ["System"]),
dependencies: ["ProcessRunner"]),
]
)
```
Expand Down
Binary file added processrunner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed system.png
Binary file not shown.

0 comments on commit bedc557

Please sign in to comment.