Skip to content

Commit

Permalink
chore: update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
tris203 committed Dec 1, 2023
1 parent aa01e54 commit 552484c
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,28 @@ It takes into consideration keyboard layout, easy to press combinations and memo

## Getting Started
Installation instructions to follow, but as usual with package managers
```lua
return {
dir = "tris203/hawtkeys.nvim",
config = true,
}
```
## Config
The default config is below, but can be changed by passing a table in config with the options

* leader is your current leader key (This will be automatic in future
* homerow is the numerical representation of the home row in your keyboard layout
* powerFingers contains which fingers are prefered for keystrokes, counted from a 0 index reading left to right. 0, 1, 2 ..9.
* Keyboard layout is the layout, currently on QWERTY is defined. More to follow

```lua
{
leader = " "
homerow = 2
powerFingers = { 2, 3, 6, 7 }
keyboardLayout = "qwerty"
}
```

## Usage

Expand Down

0 comments on commit 552484c

Please sign in to comment.