Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: README update #74

Merged
merged 1 commit into from
Jan 4, 2024
Merged

docs: README update #74

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,20 @@ Installation instructions to follow, but as usual with package managers
```lua
return {
"tris203/hawtkeys.nvim",
config = true,
dependencies = { "nvim-lua/plenary.nvim" },
config = {
-- an empty table will work for default config
--- if you use functions, or whichky, or lazy to map keys
--- then please see the API below for options
},
}
```

## ❔Usage

### Searching New Keymaps

There are two interfaces to hawtkeys, the first allows you to Search For Keymaps:
There are three interfaces to hawtkeys, the first allows you to Search For Keymaps:

```
:Hawtkeys
Expand Down
Loading