diff --git a/README.md b/README.md index fb809c6..266b518 100644 --- a/README.md +++ b/README.md @@ -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 ``` @@ -90,20 +104,6 @@ ENVIRONMENT VARIABLES Use "kks -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