Skip to content

Commit

Permalink
reformat README
Browse files Browse the repository at this point in the history
  • Loading branch information
kkga committed Sep 13, 2021
1 parent 4f0a66e commit 37e1162
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,20 @@ alias ka='kks attach'
alias kl='kks list'
```

### kks configuration

`kks` can be configured through environment variables.

At the moment, there is a single configuration option:

- `KKS_USE_GITDIR_SESSIONS`
- when set to any value and `KKS_SESSION` is empty, running `kks edit` will do
the following:
- if file is inside a git directory, `kks` will search for an existing
session based on top-level git directory name and connect to it;
- if a session for the directory doesn't exist, `kks` will start a new
session and connect to it.

### Usage

```
Expand All @@ -90,20 +104,6 @@ ENVIRONMENT VARIABLES
Use "kks <command> -h" for command usage.
```

### kks configuration

`kks` can be configured through environment variables.

At the moment, there is a single configuration option:

- `KKS_USE_GITDIR_SESSIONS`
- when set to any value and `KKS_SESSION` is empty, running `kks edit` will do
the following:
- if file is inside a git directory, `kks` will search for an existing
session based on top-level git directory name and connect to it;
- if a session for the directory doesn't exist, `kks` will start a new
session and connect to it.

### Provided scripts

- [`kks-buffers`](./scripts/kks-buffers) -- pick buffers
Expand Down

0 comments on commit 37e1162

Please sign in to comment.