aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormax397574 <[email protected]>2021-12-17 16:47:42 +0100
committermax397574 <[email protected]>2021-12-17 16:47:42 +0100
commit29a2dd38781c62b0553455c2812d5f22f066a6e9 (patch)
treea184265721b2e672e86fed1b30ad3baa5ed40214
parent5246e521c42ca64edd5e6a4225de75d77c03a7ab (diff)
docs(readme): added section about user mappings
-rw-r--r--readme.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/readme.md b/readme.md
index c93f020..25b481f 100644
--- a/readme.md
+++ b/readme.md
@@ -121,6 +121,17 @@ section = {
}
```
+### User Mappings
+You can easily add your own mappings with a function.
+You just have to provide a table with keys, command pairs like this:
+```lua
+require"startup".create_mappings({
+ ["<leader>ff"]="<cmd>Telescope find_files<CR>",
+ ["<leader>lg"]="<cmd>Telescope live_grep<CR>"
+})
+```
+Those mappings will automatically be added to the help.
+
### Buildingblocks
You can use some functions from `lua/startup/functions.lua`.