Skip to content

Commit

Permalink
docs: add configuration section to README
Browse files Browse the repository at this point in the history
  • Loading branch information
ALX99 committed May 18, 2024
1 parent 4c62297 commit 8497e82
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,22 @@ This project is inspired by the [lf](https://github.com/gokcehan/lf) file manage

## Usage

### Configuration

Sail tries to locate the config file at `$XDG_CONFIG_HOME/sail/config.yaml` or `$HOME/.config/sail/config.yaml` if `XDG_CONFIG_HOME` is not set.
If the file is not found, it will use the following default configuration:

```yaml
settings:
keymap:
left: "h"
up: "j"
down: "k"
right: "l"
in: "."
out: ","
```
### Using sail as a cd replacement
Sail can be used as a replacement for the `cd` command. To do so, you can put the following in your `.bashrc` or `.zshrc`:
Expand Down

0 comments on commit 8497e82

Please sign in to comment.