From 29a2dd38781c62b0553455c2812d5f22f066a6e9 Mon Sep 17 00:00:00 2001
From: max397574 <max.heinzer397@gmx.ch>
Date: Fri, 17 Dec 2021 16:47:42 +0100
Subject: docs(readme): added section about user mappings

---
 readme.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

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`.
-- 
cgit v1.2.3