Skip to content

Commit

Permalink
Simplify Installing section and add Nix command
Browse files Browse the repository at this point in the history
  • Loading branch information
bensadeh committed Sep 6, 2023
1 parent dd57101 commit 73c7ef9
Showing 1 changed file with 9 additions and 29 deletions.
38 changes: 9 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<img src="assets/tailspin.png" width="230"/>
</p>

#
#

<p align="center">
A log file highlighter
Expand Down Expand Up @@ -46,42 +46,22 @@ it requires no configuration or setup and will work predictably regardless of th

## Installing

### Cargo
The binary name for `tailspin` is `spin`.

```console
# Install
# Cargo
cargo install tailspin

# View log file
spin [file]
```

> **Note**
> When installing via cargo, make sure that `$HOME/.cargo/bin` is in your `PATH` environment variable
### Debian

```console
# Install
# Debian
apt install tailspin

# View log file
tailspin [file]
```

### Archlinux

```console
# Install
# AUR
paru -S tailspin

# View log file
spin [file]
# Nix
nix-shell -p tailspin
```

> **Note**
> Because of a name collision with another `apt` package, the binary name on Debian is `tailspin`
## Highlight Groups

### Dates
Expand Down Expand Up @@ -221,8 +201,8 @@ To clear the filter, use <kbd>&</kbd> with no pattern.
## Settings

```console
-f, --follow Follow (tail) the contents of the file
-t, --tail Start at the end of the file.
-f, --follow Follow the contents of the file
-t, --tail Start at the end of the file
-p, --print Print the output to stdout
-c, --config-path PATH Path to a custom configuration file
-t, --follow-command 'CMD' Follows the output of the provided command
Expand Down

0 comments on commit 73c7ef9

Please sign in to comment.