Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
BrunnerLivio committed Oct 4, 2023
1 parent 050c8be commit 733e8fc
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# tsp-web

Displays a overview of the task spooler server of your machine in real time.
[Task Spooler](https://github.com/justanhduc/task-spooler) real-time Web UI.

![TSP Web Preview](.github/screenshot.png)

Expand All @@ -19,11 +19,15 @@ chmod +x ./tsp-web*

```bash
./tsp-web*
# (Mac) If you're using the Brew package you might wanna change the task spooler binary
TSP_WEB_TS_BIN=ts ./tsp-web*
```

4. Run your first task

```bash
tsp -L sleep sleep 30
# (Mac) If you're using the Brew package you might wanna change the task spooler binary
ts -L sleep sleep 30
```

Expand All @@ -39,7 +43,7 @@ ts -L sleep sleep 30

### Configuration

The configuration of `tsp-web` can be found in the folder `$XDG_CONFIG_HOME/tsp-web/config.yml`.
The configuration of `tsp-web` can be found in the folder `$XDG_CONFIG_HOME/tsp-web/config.yml` (default `~/.config/tsp-web/config.yml`).

```yaml
commands:
Expand Down

0 comments on commit 733e8fc

Please sign in to comment.