Skip to content

Commit 5a91f1b

Browse files
authored
Update README.md (#56)
1 parent 60907ed commit 5a91f1b

File tree

1 file changed

+24
-42
lines changed

1 file changed

+24
-42
lines changed

README.md

Lines changed: 24 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -5,74 +5,56 @@
55
[![Snapcraft](https://snapcraft.io/tend/badge.svg)](https://snapcraft.io/tend)
66
[![WinGet Package Version](https://img.shields.io/winget/v/lkurcak.tend)](https://github.com/microsoft/winget-pkgs/tree/master/manifests/l/lkurcak/tend)
77

8+
A command-line tool for managing and running multiple processes.
89

9-
### Installation
10-
11-
**[Download binaries](https://github.com/lkurcak/tend/releases)** if you are using **Windows**, **macOS** or **Linux**.
12-
13-
You can install `tend` using `snap`:
14-
15-
```sh
16-
sudo snap install tend
17-
```
18-
19-
Or with `winget`:
10+
## Installation
2011

12+
**Windows:**
2113
```sh
2214
winget install lkurcak.tend
2315
```
2416

25-
Or using `cargo`:
26-
17+
**Linux (Snap):**
2718
```sh
28-
cargo install tend
19+
sudo snap install tend
2920
```
3021

31-
Or build from source:
22+
**macOS / Other:**
23+
[Download binary](https://github.com/lkurcak/tend/releases)
3224

25+
**Cargo:**
3326
```sh
34-
git clone https://github.com/lkurcak/tend
35-
cd tend
36-
cargo build --release
27+
cargo install tend
3728
```
3829

39-
### Usage
30+
## Quick Start
4031

41-
#### Basic
42-
Create a new job called `hello`:
4332
```sh
33+
# Create a job
4434
tend create "hello" ping 8.8.8.8
45-
tend run hello
46-
```
4735

48-
Press `Ctrl-C` to stop all jobs and exit the program.
36+
# Run it
37+
tend run hello
4938

50-
To view jobs enter:
51-
```sh
39+
# View all jobs
5240
tend list
5341
```
5442

55-
#### Available Programs
56-
Based on your platform and configuration you will have access to different programs and shells. Make sure the programs are accessible from your current working directory.
57-
58-
For example, you could write this on Linux:
59-
```sh
60-
tend create "time" sh -- -c 'echo Time: $(date)'
61-
```
62-
to achieve something similar as this on Windows:
63-
```sh
64-
tend create "time" cmd -- /C 'echo Time: %TIME%'
65-
```
43+
Press `Ctrl-C` to stop all jobs.
6644

67-
#### Groups
45+
## Examples
6846

69-
You can create a job as a part of a group:
47+
**Run jobs by group:**
7048
```sh
7149
tend create "postgres" --group="dev" kubectl port-forward svc/postgres 5432:5432
50+
tend run --group "dev"
7251
```
7352

74-
Start all jobs from a specific group:
53+
**Run any command available in your shell:**
7554
```sh
76-
tend run --group "dev"
77-
```
55+
# Linux
56+
tend create "time" sh -- -c 'echo Time: $(date)'
7857

58+
# Windows
59+
tend create "time" cmd -- /C "echo Time: %TIME%"
60+
```

0 commit comments

Comments
 (0)