Skip to content
This repository has been archived by the owner on Jun 17, 2023. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Nicolas committed Apr 15, 2022
1 parent 784464c commit 0ef8a0d
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,29 @@ Download options can be found in the [release tab](https://github.com/ricoriedel

## Configuration
All configuration is done using command line parameters.
If you want a persistent solution, you can add an alias to your `.bashrc` equivalent.

For a list of parameters, execute `wipe -h`.
Note that some parameters like `--color` can be specified multiple times with different values.

If you want a persistent solution, you can add an alias to your `.bashrc` equivalent.
```shell
# Persistent config
alias wipe='wipe -c red'

# Replace clear with wipe
alias clear='wipe'
```

If you are using `ZSH` as your shell, you can add a keyboard shortcut like this:
```shell
# Bind wipe to CTRL+W
wipe-zle() {
wipe
zle reset-prompt
}
zle -N wipe-zle
bindkey '^w' wipe-zle
```

## Showcase
[![Circle](doc/circle.gif)]()
[![Rhombus](doc/rhombus.gif)]()
Expand Down

0 comments on commit 0ef8a0d

Please sign in to comment.